簡訊請求

Text Request 是一個商業簡訊平台，旨在激發客戶參與度。 我們為您的日常溝通問題創建了即插即用的消息傳遞解決方案，因此您可以消除噪音並隨時隨地與客戶聯繫。 詳細了解我們如何幫助像您這樣忙碌的商業領袖。

此連接器適用於以下產品和區域：

服務	Class	Regions
副駕駛工作室	進階	除下列區域外的所有 Power Automate 區域 ：      - 美國政府 （GCC）      - 美國政府（海灣合作委員會高中）      - 由 21Vianet 營運的中國雲      - 美國國防部 （DoD）
邏輯應用程式	標準	所有 Logic Apps 區域， 但下列區域除外：      - Azure Government 區域      - Azure 中國區域      - 美國國防部 （DoD）
Power Apps	進階	除下列區域外的所有 Power Apps 區域 ：      - 美國政府 （GCC）      - 美國政府（海灣合作委員會高中）      - 由 21Vianet 營運的中國雲      - 美國國防部 （DoD）
Power Automate（自動化服務）	進階	除下列區域外的所有 Power Automate 區域 ：      - 美國政府 （GCC）      - 美國政府（海灣合作委員會高中）      - 由 21Vianet 營運的中國雲      - 美國國防部 （DoD）

連絡人​​
名稱	文字請求 API 支援
URL	https://www.textrequest.com/contact
Email	apidev@textrequest.com

連接器中繼資料
Publisher	簡訊請求
網站	https://www.textrequest.com/
隱私策略	https://www.textrequest.com/privacy-policy/
類別	傳達;銷售和客戶關係管理

Aranda 服務管理套件 （ASMS）

使用 Aranda Service Management Suite 提高公司的生產力並改變用戶體驗，Aranda Service Management Suite 是一種多租戶解決方案，可讓您管理、集成和自動化業務流程和服務。 建立、搜尋和更新儲存在 ASMS 任何工作區 （專案） 中的記錄，包括事件、需求和變更等。

Pre-requisites

請記住以下先決條件以繼續：

• Aranda Service Management Suite （ASMS） 的訂閱和執行個體。 從這裡開始： https://arandasoft.com/
• 具有進階連接器功能的作用中 Microsoft Power Automate 訂用帳戶。

取得憑證

• 若要執行驗證，請使用整合權杖。 在以下鏈接中，您將找到有關如何獲取集成令牌的信息

開始使用連接器

1. 需要訂閱 Aranda Service Management Suite （ASMS）。

2. 取得 整合權杖

3. 取得 Aranda 服務管理 ASMS API （ApiAsms） 的執行個體 URL。

4. 與 Aranda Service Management Suite 連接器建立連線。

5. 選取連接器提供的下列其中一個功能：

6. 有關連接器的詳細文檔，請參閱 https://docs.arandasoft.com/connectors

您可以在下列情況下使用此連接器：

1. 建立、搜尋和更新票證，以及其他可用的操作。
2. 取得票證可追溯性。
3. 下載與票證相關的附件。
4. 在 Aranda Service Management Suite 中搜尋知識庫 （KB） 文章。
5. 從知識庫 （KB） 文章下載附件。
6. 建立、搜尋及更新配置項目 （CI）。
7. 它允許組織解決其內部支援請求，管理和簡化技術問題解決流程。
8. 允許追蹤請求者和支援代理之間的通訊。
9. 提供自動回复以通知請求者其票證狀態。

成功回應

Code	名稱	Description
200	OK	要求成功
204	無內容	在請求中找不到資料

常見錯誤和補救措施

Code	名稱	Description	Solution
400	錯誤的請求	條件需要一些參數	檢查搜尋參數是否為空
400	錯誤的請求	無效的附加欄位識別碼	檢查其他欄位的 ID 是否正確
400	錯誤的請求	無效項目類型	案例類型不正確，請變更案例類型識別碼
400	錯誤的請求	無效的專案標識符	專案識別碼不正確，請變更您要將案例相關聯的專案識別碼
400	錯誤的請求	無效狀態標識碼	建立或更新工單時檢查新增的狀態
400	錯誤的請求	無效上傳類型	附加檔案時發生錯誤，向系統管理員請求協助
400	錯誤的請求	RequestNeedsSome引數	檢查票證的必填欄位，並在連接器中新增這些欄位的對應值
400	錯誤的請求	SearchListIs必填	向系統管理員請求協助
400	錯誤的請求	參數名稱：{Name parameter}	檢查錯誤中提及的屬性是否為 Null
400	錯誤的請求	是否為空參數名稱：{Name parameter}	檢查錯誤中提及的屬性是否為 Null
400	錯誤的請求	ItemTypeIsRequired	新增案例類型
400	錯誤的請求	ModelIdIs空	新增 modelId 參數。 此為必要。
400	錯誤的請求	StateIdIs空	新增 stateId 參數。 此為必要。
400	錯誤的請求	ServiceIdIs空白	新增 serviceId 參數。 此為必要。
400	錯誤的請求	類別Id是空的	新增 categoryId 參數。 此為必要。
400	錯誤的請求	類型清單需求一些引數	搜尋票證時需要新增案例類型，向系統管理員請求協助
400	錯誤的請求	'{PARAMETER_NAME}' AdditionalFieldIsRequired	附加欄位 '{PARAMETER_NAME}' 是必填欄位 '{}'
400	錯誤的請求	ModelNotActive	與案例相關聯的模型未使用中
400	錯誤的請求	FailedToCloseTaskPendingCloseTasks前置任務	如果您嘗試關閉案例，且父案例有待處理的工作要關閉
400	錯誤的請求	重複物件	資料庫中已存在 Ci
400	錯誤的請求	EmptyValue 參數名稱：{PARAMETER_NAME}	{PARAMETER_NAME} 參數是必填的
400	錯誤的請求	EmptyEnumeration 參數名稱：{PARAMETER_NAME}	{PARAMETER_NAME} 參數是清單，是必填專案
403	禁止	DoNotHavePermissionForThisAction	與您的系統管理員交談以分配權限

Code	名稱	Description	Solution
500	內部伺服器錯誤		向系統管理員請求協助
500	內部伺服器錯誤	失敗匯出Excel	向系統管理員請求協助
500	內部伺服器錯誤	FailureGetAdditional欄位	向系統管理員請求協助
500	內部伺服器錯誤	FailureGetCategoriesByService	向系統管理員請求協助
500	內部伺服器錯誤	失敗GetChangeFSC	向系統管理員請求協助
500	內部伺服器錯誤	FailureGet欄位	向系統管理員請求協助
500	內部伺服器錯誤	FailureGetFields清單	向系統管理員請求協助
500	內部伺服器錯誤	失敗Get檔案	向系統管理員請求協助
500	內部伺服器錯誤	FailureGetLookup值	向系統管理員請求協助
500	內部伺服器錯誤	失敗GetMailTemplates	向系統管理員請求協助
500	內部伺服器錯誤	FailureGetModelByCategory	向系統管理員請求協助
500	內部伺服器錯誤	FailureGet運算子	向系統管理員請求協助
500	內部伺服器錯誤	FailureGetReassignment原因	向系統管理員請求協助
500	內部伺服器錯誤	FailureGetSimilarItems	向系統管理員請求協助
500	內部伺服器錯誤	失敗搜尋快速管理	向系統管理員請求協助

FAQ

1. 如何擷取在聯結器中使用不同動作所需的屬性 ID （例如專案、服務、類別、群組、專家）？

   可以透過多種方式擷取 ID：

   • 使用 Aranda 查詢管理器，您可以建立報告來查詢所需資料所在的 Aranda Service Management Suite （ASMS） 表格。 如果您需要解決方案中資料物件的指引，請造訪下列連結 https://docs.arandasoft.com/docs/database.html ，並識別與您的 ASMS 安裝相對應的 Aranda 資料庫版本。
   • 如果您使用 ASMS 內部部署安裝，則可以透過 SQL 用戶端查詢所需資料所在的 ASMS 資料表。
   • 通過 Aranda 支持中心，通過 以下網站上指示的聯繫渠道創建支持請求 支持。

2. 使用「新增附件」動作時要附加的檔案大小上限是多少？

   大小上限取決於 ASMS 執行個體/安裝的特定組態。 請詢問您的 ASMS 管理員。

3. 其權杖用於連接器所需的ASMS連線配置的技術人員帳戶所需的資料存取層級是什麼？

   存取層級與 ASMS 中定期使用的技術人員帳戶相同。 換句話說，根據 ASMS 中相應技術人員的角色和權限，可以使用連接器存取資料。

4. 其權杖將在連接器中使用的技術人員帳戶應該是具名還是並行？

   由於連接器每小時可以多次存取相關的 ASMS 執行個體，因此強烈建議帳戶為具名類型。

5. 使用連接器建立或修改案例是否遵循 ASMS 介面中存在的相同資料驗證規則？

   是的，它遵循相同的驗證規則。 例如，為特定專案、服務和類別建立案例時，如果必須填寫原生和其他欄位，則透過連接器提交案例時也需要這些資料。

6. 連接器是否可用於雲端和內部部署環境中的 ASMS 執行個體？

   是的，它可以用於 ASMS 的雲端和內部部署安裝。 在內部部署安裝中，您必須考慮 ASMS 伺服器與 Power Automate 環境之間的連線能力。

7. 我有一個 Power Automate 授權，只允許我使用標準連接器。 我可以使用 ASMS 連接器嗎？

   這是不可能的，ASMS連接器是高級型別。

8. 我想在 Power Automate 中建立從 ASMS 中的事件開始的流程 （例如，建立案例時、將案例指派給特定群組時）。 是否可以使用從 ASMS 中發生的事件開始的觸發器？

   是的，這是可能的。 建議採取以下步驟：

   • 初始化觸發器「收到 HTTP 請求時」，並建立請求內文 JSON 結構描述，其中包含預期從 ASMS 接收的資料結構。 建立觸發器之後，您將取得 HTTP POST URL （WebHook URL） 以用於 ASMS 執行個體。 不要忘記考慮存取 WebHook URL 的身份驗證機制（例如權杖）。
   • 在 ASMS 中建立一組條件的商務規則，當符合這些條件時，應在 Power Automate 中啟動流程。 作為規則內的動作，請選取「叫用 Webhook」，然後在叫用目的地 URL 中輸入先前取得的 WebHook URL、要傳送的參數，以及要求的內文 （必須符合要求內文 JSON 結構描述）。 如需如何從 ASMS 中的規則叫用 Webhook 的詳細資訊，請瀏覽下列連結： Webhook 規則
   • 測試建立的規則，並驗證 HTTP 要求是否傳送至 WebHook URL，並在 Power Automate 中初始化流程。

9. 我可以從 Power Automate 中的流程叫用 ASMS REST API 端點作為動作嗎？

   是的，這是可能的。 使用「HTTP」操作並在其中填寫所需的資料（URI、方法、標頭、正文等）。

正在建立連線

連接器支援下列驗證類型：

預設值	建立連線的參數。	所有區域	不可共享

預設

適用：所有地區

建立連線的參數。

這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

名稱	類型	Description	為必填項目
API 金鑰	securestring	此 API 的 API 金鑰	對

節流限制

名稱	呼叫	續約期間
每個連線的 API 呼叫	100	60 秒

動作

使用指定的電話號碼向聯絡人發送訊息	傳送訊息 （如果指定的電話號碼沒有訊息記錄，則開始新的對話）。
使用給定的 ID 更新群組	使用群組的數字 ID 更新群組名稱。如果傳入的群組識別碼不存在，則呼叫將會失敗。
使用給定的名稱和電話號碼建立新的儀表板	在帳戶中建立新的儀表板。 建立儀表板後，管理員將收到有關變更的電子郵件，並可以開始指派使用者。 此端點可以為任何佈建的號碼建立儀表板。 您可以使用 GET /dashboards/provisioning 搜尋特定區號中的佈建號碼。 如果電話號碼已在使用中，則會擲回錯誤要求例外狀況。
依群組識別碼取得群組	取得具有指定識別碼的群組。
刪除具有指定 ID 的群組	刪除具有指定 ID 的群組。即使有聯絡人是群組成員，這也會成功（聯絡人不會被刪除）。
刪除具有指定電話號碼的聯絡人	刪除具有指定電話號碼的聯絡人
刪除指定的儀表板	刪除指定的儀表板。
取得具有指定 ID 的付款	取得具有指定 ID 的付款。
取得具有指定電話號碼的連絡人	取得具有指定電話號碼的連絡人
取得帳戶中的所有儀表板	取得帳戶中的所有儀表板。
取得所有標籤	取得此儀表板的所有標籤。 標籤在儀表板之間是唯一的。
取得所有群組	取得使用者帳戶的所有群組。
取得所有自訂欄位	取得此儀表板的所有自訂欄位。 自訂欄位在儀表板之間是唯一的。
取得此儀表板的所有交談	取得此儀表板的所有交談，並包含每個交談的最後一則訊息的相關資訊。
取得此特定儀表板的資訊	傳回儀表板的名稱和電話。
取得符合指定篩選條件的所有連絡人	取得符合指定篩選條件的所有聯絡人。 只會搜尋指定的儀表板;沒有帳戶層級搜尋可用的號碼。
取消封存對話	取消封存對話。 一旦對話取消存檔，它將再次出現在佇列中。 它也會出現在 /conversations 端點傳回的交談中。 如果交談已取消封存，則此方法無效。
取消指定的付款	取消指定的付款，並傳送簡訊給使用者付款已取消。 付款無法編輯，因此取消並發放新付款是更正付款的最佳方式。
大量更新聯絡人	只有指定的儀表板才會新增聯絡人;聯絡人是按儀表板組織的，並且沒有帳戶層級搜尋可用的號碼。
封存對話	封存交談，將其從所有交談擷取端點的結果中移除。 如果客戶向您的簡訊請求號碼傳送簡訊，或您從簡訊請求號碼向客戶傳送簡訊，對話將自動取消封存。 存檔對話是消除您未來不打算與之交談的客戶的混亂的好方法。 請注意，如果客戶在“STOP”中發送短信以防止您向他們發送任何進一步的短信，則對話會自動存檔。
將付款標示為已付款	將付款關閉為「已付款」。 當透過付款要求入口網站以外的方式支付付款時，請使用此端點。 這將關閉付款並將其付款金額添加到您的統計資料中。 透過文字請求傳送的付款入口網站支付的付款不需要此端點;這會自動將付款標記為已付款。
建立或更新聯絡人	建立或更新聯絡人（取決於是否已經存在具有指定電話號碼的聯絡人）。
建立新的付款	使用提供的訊息建立新的付款給提供的聯絡人。
建立新群組	使用提供的名稱建立新群組。
更新特定儀表板的名稱	更新儀表板。 這不會變更儀表板的電話號碼。 如果您想要一個包含另一個儀表板聯繫人的新號碼，則必須使用 POST 創建一個新儀表板，並通過批量導出/導入添加聯繫人。
獲得所有付款	取得所有付款，包括已取消和已付款。 這些可以使用查詢參數進行過濾。
發送後續文本，提醒用戶支付指定的付款	傳送提醒給聯絡人支付指定的付款。 訊息的內容是自動產生的。 為避免垃圾郵件，每次付款只能發送一次提醒
透過連絡人的電話號碼取得交談的訊息	取得指定儀表板與電話號碼之間的交談。

使用指定的電話號碼向聯絡人發送訊息

作業識別碼：

SendMessageByPhoneNumber

傳送訊息 （如果指定的電話號碼沒有訊息記錄，則開始新的對話）。

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
要留言的電話號碼	phone_number	True	string	要傳送訊息的連絡人的電話號碼。
訊息內文	body		string	要傳送的訊息內容。
寄件者名稱	sender_name		string	訊息寄件者的名稱。 擷取此訊息時，這會顯示在 TextRequest Web 應用程式和 API 中。
訊息狀態更新時的回呼 URL	status_callback		string	每當此訊息的狀態從未傳遞變為已傳送 （或錯誤） 時，Web 應用程式會以 POST 命令點擊的 URL。
位置要求的回呼 URL（如果此訊息包含一個）	location_callback		string	當使用者存取並核准與寄件者共用其位置時，使用 POST 命令點擊的位置回呼 URL。 若要包含連結，請將 [位置請求] 新增至訊息內文。 位置請求不需要此回呼，但對於 API 很有用。
此訊息的彩信媒體附件	mms_media		array of string	此訊息的 MMS 媒體附件陣列。 附件必須是從 post /mms 端點取得的 URL（不包含在此連接器中）。 不接受外部附件連結。

傳回

名稱	路徑	類型	Description
message_id	message_id	string	訊息的 ID。 此值對於每則訊息都是唯一的。
body	body	string	此訊息的內容。
message_direction	message_direction	string	單數字元 R 或 S，分別表示此訊息是從聯絡人接收還是傳送給他們。
response_by_username	response_by_username	string	上次傳送訊息給此使用者的文字要求使用者的使用者名稱。
message_timestamp_utc	message_timestamp_utc	string	文字要求傳送或接收訊息的時間戳記。
delivery_status	delivery_status	string	此訊息的目前狀態。 這可以是「發送」、「已交付」、「錯誤」或「發送」。
delivery_error	delivery_error	string	導致無法傳送此訊息的錯誤。 如果delivery_status不是 'error'，則此值將為 null。
mms_media	mms_media	array of string	指向此郵件附件的 URL 清單。 所有 url 都將是文本請求生成的 url。

使用給定的 ID 更新群組

作業識別碼：

UpdateGroup

使用群組的數字 ID 更新群組名稱。如果傳入的群組識別碼不存在，則呼叫將會失敗。

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
群組的標識碼	group_id	True	integer	要更新之群組的數字識別碼。
群組名稱	name		string	群組的新名稱。
群組筆記	notes		string	描述群體的簡短短語。 為了方便起見。

傳回

名稱	路徑	類型	Description
識別碼	id	integer	群組的數字識別碼。
group_member_count	group_member_count	integer	群組的成員數目。
is_keyword	is_keyword	boolean	無論此群組是關鍵字群組。 當使用者設定關鍵字時，會自動產生此類群組。 聯絡人註冊時會自動新增。
名稱	name	string	此群組的名稱。
附註	notes	string	關於這個組的任何註釋。
last_message_sent_utc	last_message_sent_utc	string	為此群組傳送最後一次群組訊息的時間戳記。

使用給定的名稱和電話號碼建立新的儀表板

作業識別碼：

CreateDashboard

在帳戶中建立新的儀表板。 建立儀表板後，管理員將收到有關變更的電子郵件，並可以開始指派使用者。 此端點可以為任何佈建的號碼建立儀表板。 您可以使用 GET /dashboards/provisioning 搜尋特定區號中的佈建號碼。 如果電話號碼已在使用中，則會擲回錯誤要求例外狀況。

參數

名稱	機碼	必要	類型	Description
名稱	name		string	儀錶板的名稱。
phone	phone		string	與此儀表板相關聯的簡訊號碼。

傳回

名稱	路徑	類型	Description
識別碼	id	integer	儀表板的數字識別碼。
名稱	name	string	儀錶板的名稱。
phone	phone	string	與此儀表板相關聯的簡訊號碼。

依群組識別碼取得群組

作業識別碼：

GetGroupById

取得具有指定識別碼的群組。

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
群組的標識碼	group_id	True	integer	要取得的群組的數字識別碼。

傳回

名稱	路徑	類型	Description
識別碼	id	integer	群組的數字識別碼。
group_member_count	group_member_count	integer	群組的成員數目。
is_keyword	is_keyword	boolean	無論此群組是關鍵字群組。 當使用者設定關鍵字時，會自動產生此類群組。 聯絡人註冊時會自動新增。
名稱	name	string	此群組的名稱。
附註	notes	string	關於這個組的任何註釋。
last_message_sent_utc	last_message_sent_utc	string	為此群組傳送最後一次群組訊息的時間戳記。

刪除具有指定 ID 的群組

作業識別碼：

DeleteGroup

刪除具有指定 ID 的群組。即使有聯絡人是群組成員，這也會成功（聯絡人不會被刪除）。

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
群組的標識碼	group_id	True	integer	要刪除之群組的數字識別碼。

傳回

response

string

刪除具有指定電話號碼的聯絡人

作業識別碼：

DeleteContact

刪除具有指定電話號碼的聯絡人

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
聯絡電話	phone_number	True	string	要刪除的聯絡人的電話號碼。

傳回

response

string

刪除指定的儀表板

作業識別碼：

DeleteDashboard

刪除指定的儀表板。

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。

傳回

response

string

取得具有指定 ID 的付款

作業識別碼：

GetPayment

取得具有指定 ID 的付款。

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
付款的 ID	payment_id	True	integer	要取得的付款的數字 ID。

傳回

名稱	路徑	類型	Description
payment_id	payment_id	integer	付款的數字 ID。
request_date	request_date	string	此付款的初始訊息排入佇列等待傳送的時間戳記。
收件者	recipient	string	付款收件者的名稱。 如果聯絡人沒有與其電話號碼相關聯的姓名，則此值可能為空。
描述	description	string	付款說明。 這不會顯示給聯絡人。 它僅供內部使用者用於有關付款的上下文。
customer_phone	customer_phone	string	接收此付款的連絡人的電話號碼。
amount_requested	amount_requested	float	此付款要求的金額（以美元為單位）。
is_past_due	is_past_due	boolean	此付款是否超過請求日期。
reminder_was_sent	reminder_was_sent	boolean	是否已針對此付款發送文字提醒。
transaction_status	transaction_status	string	authvia 中交易的狀態。 此值開頭為 Unknown。
textrequest_payment_status	textrequest_payment_status	string	「文字要求」中的交易狀態。 這代表文字請求應用程式付款頁面中顯示的狀態。 它從「已發送」開始。
reference_number	reference_number	string	建立付款時定義的使用者定義 ID，可用來快速尋找付款。 參考編號不是唯一的;許多付款可以具有相同的參考。

取得具有指定電話號碼的連絡人

作業識別碼：

GetContactByPhoneNumber

取得具有指定電話號碼的連絡人

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
聯絡人的電話號碼	phone_number	True	string	要取得的聯絡人的電話號碼。

傳回

名稱	路徑	類型	Description
電話號碼	phone_number	string	該聯絡人的電話號碼。
first_name	first_name	string	該聯絡人的名字。
last_name	last_name	string	此聯絡人的姓氏。
display_name	display_name	string	該聯絡人的全名。 這是檢視聯絡人時 Web 應用程式中顯示的預設名稱。
is_suppressed	is_suppressed	boolean	是否隱藏與此聯絡人的交談，因此在收到時不會推送到訊息佇列的頂端。
is_archived	is_archived	boolean	與此聯絡人的交談是否已封存，因此在查詢交談時無法看到 （預設）。
is_blocked	is_blocked	boolean	與此聯絡人的交談是否遭到封鎖，因此不會接收或儲存。
suppressed_reason	suppressed_reason	string	描述抑制聯繫原因的短語。 如果is_suppressed為 false，則為 null。
注意	note	string	描述接觸的簡短短語。 為了方便起見。 這永遠不會顯示給聯絡人。
groups	groups	array of integer	參考此聯絡人所屬群組的整數 ID 陣列。
contact_tags	contact_tags	array of string	參考附加至此連絡人的標籤的 GUID 陣列。
custom_fields	custom_fields	array of object	為此聯絡人定義的自訂欄位 ID 和值陣列。
識別碼	custom_fields.id	string	Guid 參考自訂欄位。
value	custom_fields.value	string	此連絡人此自訂欄位的值。
is_resolved	is_resolved	boolean	與此聯絡人的交談是否已解決。 此聯絡人收到的任何新簡訊都會設定此 false。
first_contact_utc	first_contact_utc	string	將第一則訊息傳送給此聯絡人的時間戳記。
opted_out_utc	opted_out_utc	string	此聯絡人選擇不接收訊息的時間戳記。
last_msg_sent_utc	last_msg_sent_utc	string	最後一則訊息傳送給此聯絡人的時間戳記。
last_msg_received_utc	last_msg_received_utc	string	從此聯絡人收到最後一則訊息的時間戳記。
total_msgs_sent	total_msgs_sent	integer	傳送給此聯絡人的訊息總數。
total_msgs_received	total_msgs_received	integer	從此聯絡人收到的訊息總數。
response_count	response_count	integer	來自聯絡人的回應訊息總數。
date_created_utc	date_created_utc	string	建立聯絡人的時間戳記。
last_contact_date_utc	last_contact_date_utc	string	從此聯絡人傳送或接收最後一則訊息的時間戳記。
message_id	last_message.message_id	string	訊息的 ID。 此值對於每則訊息都是唯一的。
body	last_message.body	string	此訊息的內容。
message_direction	last_message.message_direction	string	單數字元 R 或 S，分別表示此訊息是從聯絡人接收還是傳送給他們。
response_by_username	last_message.response_by_username	string	上次傳送訊息給此使用者的文字要求使用者的使用者名稱。
message_timestamp_utc	last_message.message_timestamp_utc	string	文字要求傳送或接收訊息的時間戳記。
delivery_status	last_message.delivery_status	string	此訊息的目前狀態。 這可以是「發送」、「已交付」、「錯誤」或「發送」。
delivery_error	last_message.delivery_error	string	導致無法傳送此訊息的錯誤。 如果delivery_status不是 'error'，則此值將為 null。
mms_media	last_message.mms_media	array of string	指向此郵件附件的 URL 清單。 所有 url 都將是文本請求生成的 url。

取得帳戶中的所有儀表板

作業識別碼：

GetDashboards

取得帳戶中的所有儀表板。

參數

名稱	機碼	必要	類型	Description
要取得的編號頁	page		integer	要取得的實體頁面。 取得值時，每頁有最大大小，由page_size定義。 如果page大於最後一頁，則會傳回一個空陣列。
每頁要取得的每個實體數量	page_size		integer	要取得的每頁大小。 取得值時，這是每頁的最大大小，存取後續頁面由 page 引數完成。

傳回

名稱	路徑	類型	Description
頁面	meta.page	integer	獲得的實體頁面。 此頁面中的實體數量由page_size定義。
page_size	meta.page_size	integer	此頁面中取得的實體數目。
total_items	meta.total_items	integer	資料庫中可用的實體數目，不論頁面大小或數目為何。 若要查看其他頁面，請變更請求中的頁碼。
items	items	array of object	從文字請求取得的儀表板實體清單。
識別碼	items.id	integer	儀表板的數字識別碼。
名稱	items.name	string	儀錶板的名稱。
phone	items.phone	string	與此儀表板相關聯的簡訊號碼。

取得所有標籤

作業識別碼：

GetTags

取得此儀表板的所有標籤。 標籤在儀表板之間是唯一的。

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
要取得的編號頁	page	True	integer	要取得的實體頁面。 取得值時，每頁有最大大小，由page_size定義。 如果page大於最後一頁，則會傳回一個空陣列。
每頁要取得的每個實體數量	page_size	True	integer	要取得的每頁大小。 取得值時，這是每頁的最大大小，存取後續頁面由 page 引數完成。

傳回

名稱	路徑	類型	Description
頁面	meta.page	integer	獲得的實體頁面。 此頁面中的實體數量由page_size定義。
page_size	meta.page_size	integer	此頁面中取得的實體數目。
total_items	meta.total_items	integer	資料庫中可用的實體數目，不論頁面大小或數目為何。 若要查看其他頁面，請變更請求中的頁碼。
items	items	array of object	從文字請求取得的標籤實體清單。
識別碼	items.id	string	標籤的數字識別碼。
tag_color	items.tag_color	string	標籤的顏色。 這應該是有效的十六進位顏色代碼。
加標籤	items.tag	string	標籤的名稱。

取得所有群組

作業識別碼：

GetGroups

取得使用者帳戶的所有群組。

參數

名稱	機碼	必要	類型	Description
要取得的編號頁	page	True	integer	要取得的實體頁面。 取得值時，每頁有最大大小，由page_size定義。 如果page大於最後一頁，則會傳回一個空陣列。
每頁要取得的每個實體數量	page_size	True	integer	要取得的每頁大小。 取得值時，這是每頁的最大大小，存取後續頁面由 page 引數完成。
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。

傳回

名稱	路徑	類型	Description
頁面	meta.page	integer	獲得的實體頁面。 此頁面中的實體數量由page_size定義。
page_size	meta.page_size	integer	此頁面中取得的實體數目。
total_items	meta.total_items	integer	資料庫中可用的實體數目，不論頁面大小或數目為何。 若要查看其他頁面，請變更請求中的頁碼。
items	items	array of object	從文字請求取得的群組實體清單。
識別碼	items.id	integer	群組的數字識別碼。
group_member_count	items.group_member_count	integer	群組的成員數目。
is_keyword	items.is_keyword	boolean	無論此群組是關鍵字群組。 當使用者設定關鍵字時，會自動產生此類群組。 聯絡人註冊時會自動新增。
名稱	items.name	string	此群組的名稱。
附註	items.notes	string	關於這個組的任何註釋。
last_message_sent_utc	items.last_message_sent_utc	string	傳送此群組的最後一次群組訊息的時間戳記。

取得所有自訂欄位

作業識別碼：

GetCustomFields

取得此儀表板的所有自訂欄位。 自訂欄位在儀表板之間是唯一的。

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。

傳回

名稱	路徑	類型	Description
		array of object
識別碼	id	string	欄位的數字識別碼。
名稱	name	string	自訂欄位的名稱。

取得此儀表板的所有交談

作業識別碼：

GetConversations

取得此儀表板的所有交談，並包含每個交談的最後一則訊息的相關資訊。

參數

名稱	機碼	必要	類型	Description
聯絡標籤	tags		string	以逗號分隔的 guid 清單，參照要篩選交談的標籤。
是否只顯示已解決的對話	show_unresolved_only		string	是否只搜尋交談已解決的聯絡人。 如果這是 false，則會同時顯示已解決和未解決的交談。
是否包含封存的對話	include_archived		string	是否包含與已封存之連絡人的交談。
要篩選電話號碼和連絡人姓名的字詞	search		string	用於按電話號碼或顯示名稱過濾對話的搜索詞。 如果搜尋字詞小於全名或電話號碼，搜尋將傳回部分符合的所有對話。
要取得的編號頁	page		integer	要取得的實體頁面。 取得值時，每頁有最大大小，由page_size定義。 如果page大於最後一頁，則會傳回一個空陣列。
每頁要取得的每個實體數量	page_size		integer	要取得的每頁大小。 取得值時，這是每頁的最大大小，存取後續頁面由 page 引數完成。
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。

傳回

名稱	路徑	類型	Description
頁面	meta.page	integer	獲得的實體頁面。 此頁面中的實體數量由page_size定義。
page_size	meta.page_size	integer	此頁面中取得的實體數目。
total_items	meta.total_items	integer	資料庫中可用的實體數目，不論頁面大小或數目為何。 若要查看其他頁面，請變更請求中的頁碼。
items	items	array of object	從文字要求取得的交談實體清單。
電話號碼	items.phone_number	string	連絡人的電話號碼。
message_id	items.last_message.message_id	string	訊息的 ID。 此值對於每則訊息都是唯一的。
body	items.last_message.body	string	此訊息的內容。
message_direction	items.last_message.message_direction	string	單數字元 R 或 S，分別表示此訊息是從聯絡人接收還是傳送給他們。
response_by_username	items.last_message.response_by_username	string	上次傳送訊息給此使用者的文字要求使用者的使用者名稱。
message_timestamp_utc	items.last_message.message_timestamp_utc	string	文字要求傳送或接收訊息的時間戳記。
delivery_status	items.last_message.delivery_status	string	此訊息的目前狀態。 這可以是「發送」、「已交付」、「錯誤」或「發送」。
delivery_error	items.last_message.delivery_error	string	導致無法傳送此訊息的錯誤。 如果delivery_status不是 'error'，則此值將為 null。
mms_media	items.last_message.mms_media	array of string	指向此郵件附件的 URL 清單。 所有 url 都將是文本請求生成的 url。

取得此特定儀表板的資訊

作業識別碼：

GetDashboard

傳回儀表板的名稱和電話。

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。

傳回

名稱	路徑	類型	Description
識別碼	id	integer	儀表板的數字識別碼。
名稱	name	string	儀錶板的名稱。
phone	phone	string	與此儀表板相關聯的簡訊號碼。

取得符合指定篩選條件的所有連絡人

作業識別碼：

GetContacts

取得符合指定篩選條件的所有聯絡人。 只會搜尋指定的儀表板;沒有帳戶層級搜尋可用的號碼。

參數

名稱	機碼	必要	類型	Description
要搜尋的連絡人電話號碼	contact_phone_number		string	要篩選聯絡人的電話號碼。
「Last-message-time called before」搜尋時間戳記（UTC 時間）	last_message_timestamp_before_utc		date-time	按發送或接收的最後一則消息搜索聯繫人的截止時間。 在此時間之後發送消息的聯繫人將不會顯示。
「最後訊息傳送時間」搜尋時間戳記（UTC 時間）	last_message_timestamp_after_utc		date-time	按發送或接收的最後一則消息搜索聯繫人的截止時間。 不會顯示上次傳送訊息在此時間之前的連絡人。
「之前建立」搜尋時間戳記	contact_created_before		date-time	搜尋聯絡人的截止時間。 在此時間之後建立的聯絡人將不會顯示。
「建立時間戳記」搜尋時間戳記	contact_created_after		date-time	搜尋聯絡人的截止時間。 在此時間之前建立的聯絡人不會顯示。
連絡人的交談是否已解決	is_resolved		boolean	是否搜尋交談已解決的聯絡人。
是否封鎖了聯繫	is_blocked		boolean	是否搜尋被封鎖的聯絡人。
聯絡人是否已封存	is_archived		boolean	是否搜尋已封存的聯絡人。
是否抑制接觸	is_suppressed		boolean	是否搜尋被隱藏的聯絡人。
聯絡人是否已選擇退出	has_opted_out		boolean	是否搜尋已選擇不接收簡訊的聯絡人。
「上次傳送訊息時間之前」搜尋時間戳記	last_message_sent_before		date-time	搜尋連絡人的截止時間，以最後一則訊息傳送給客戶的時間為依據。 在此時間之後發送消息的聯繫人將不會顯示。 使用時間戳記作為當地時間。 若要依 UTC 時間戳記進行篩選，請使用 last_message_sent_before_utc
「最後訊息傳送時間」搜尋時間戳記	last_message_sent_after		date-time	搜尋連絡人的截止時間，以最後一則訊息傳送給客戶的時間為依據。 不會顯示上次傳送訊息在此時間之前的連絡人。 使用時間戳記作為當地時間。 若要依 UTC 時間戳記進行篩選，請使用 last_message_sent_after_utc
「之前收到的訊息時間」搜尋時間戳記	last_message_received_before		date-time	按從客戶收到的最後一條消息搜索聯繫人的截止時間。 在此時間之後收到訊息的聯絡人將不會顯示。 使用時間戳記作為當地時間。 若要依 UTC 時間戳記進行篩選，請使用 last_message_sent_before_utc
「上次收到訊息的時間」搜尋時間戳記	last_message_received_after		date-time	按從客戶收到的最後一條消息搜索聯繫人的截止時間。 不會顯示上次傳送訊息在此時間之前的連絡人。 使用時間戳記作為當地時間。 若要依 UTC 時間戳記進行篩選，請使用 last_message_sent_before_utc
聯絡標籤	tags		string	以逗號分隔的 GUID 清單，參照要篩選連絡人的標籤。
聯絡人群組	groups		string	以逗號分隔的整數 ID 清單，引用要篩選聯絡人的群組。
要篩選的自訂欄位 ID	custom_field_id_1		string	Guid 參考自定義字段來過濾聯繫人。
要篩選的自訂欄位值	custom_field_value_1		string	參考用於篩選聯絡人的自訂欄位的值。
要篩選的第二個自訂欄位的 ID	custom_field_id_2		string	Guid 參考第二個自定義字段以過濾聯繫人。
要篩選依據的第二個自訂欄位值	custom_field_value_2		string	參考第二個自訂欄位以篩選聯絡人的值。
要篩選的第三個自訂欄位的 ID	custom_field_id_3		string	Guid 參考第三個自定義字段來過濾聯繫人。
要篩選依據的第三個自訂欄位值	custom_field_value_3		string	參考第三個自訂欄位以篩選聯絡人的值。
要取得的編號頁	page	True	integer	要取得的實體頁面。 取得值時，每頁有最大大小，由page_size定義。 如果page大於最後一頁，則會傳回一個空陣列。
每頁要取得的每個實體數量	page_size	True	integer	要取得的每頁大小。 取得值時，這是每頁的最大大小，存取後續頁面由 page 引數完成。
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。

傳回

名稱	路徑	類型	Description
頁面	meta.page	integer	獲得的實體頁面。 此頁面中的實體數量由page_size定義。
page_size	meta.page_size	integer	此頁面中取得的實體數目。
total_items	meta.total_items	integer	資料庫中可用的實體數目，不論頁面大小或數目為何。 若要查看其他頁面，請變更請求中的頁碼。
items	items	array of object	從文字請求取得的聯絡人實體清單。
電話號碼	items.phone_number	string	該聯絡人的電話號碼。
first_name	items.first_name	string	該聯絡人的名字。
last_name	items.last_name	string	此聯絡人的姓氏。
display_name	items.display_name	string	該聯絡人的全名。 這是檢視聯絡人時 Web 應用程式中顯示的預設名稱。
is_suppressed	items.is_suppressed	boolean	是否隱藏與此聯絡人的交談，因此在收到時不會推送到訊息佇列的頂端。
is_archived	items.is_archived	boolean	與此聯絡人的交談是否已封存，因此在查詢交談時無法看到 （預設）。
is_blocked	items.is_blocked	boolean	與此聯絡人的交談是否遭到封鎖，因此不會接收或儲存。
suppressed_reason	items.suppressed_reason	string	描述抑制聯繫原因的短語。 如果is_suppressed為 false，則為 null。
注意	items.note	string	描述接觸的簡短短語。 為了方便起見。 這永遠不會顯示給聯絡人。
groups	items.groups	array of integer	參考此聯絡人所屬群組的整數 ID 陣列。
contact_tags	items.contact_tags	array of string	參考附加至此連絡人的標籤的 GUID 陣列。
custom_fields	items.custom_fields	array of object	為此聯絡人定義的自訂欄位 ID 和值陣列。
識別碼	items.custom_fields.id	string	Guid 參考自訂欄位。
value	items.custom_fields.value	string	此連絡人此自訂欄位的值。
is_resolved	items.is_resolved	boolean	與此聯絡人的交談是否已解決。 此聯絡人收到的任何新簡訊都會設定此 false。
first_contact_utc	items.first_contact_utc	string	將第一則訊息傳送給此聯絡人的時間戳記。
opted_out_utc	items.opted_out_utc	string	此聯絡人選擇不接收訊息的時間戳記。
last_msg_sent_utc	items.last_msg_sent_utc	string	最後一則訊息傳送給此聯絡人的時間戳記。
last_msg_received_utc	items.last_msg_received_utc	string	從此聯絡人收到最後一則訊息的時間戳記。
total_msgs_sent	items.total_msgs_sent	integer	傳送給此聯絡人的訊息總數。
total_msgs_received	items.total_msgs_received	integer	從此聯絡人收到的訊息總數。
response_count	items.response_count	integer	來自聯絡人的回應訊息總數。
date_created_utc	items.date_created_utc	string	建立聯絡人的時間戳記。
last_contact_date_utc	items.last_contact_date_utc	string	從此聯絡人傳送或接收最後一則訊息的時間戳記。
message_id	items.last_message.message_id	string	訊息的 ID。 此值對於每則訊息都是唯一的。
body	items.last_message.body	string	此訊息的內容。
message_direction	items.last_message.message_direction	string	單數字元 R 或 S，分別表示此訊息是從聯絡人接收還是傳送給他們。
response_by_username	items.last_message.response_by_username	string	上次傳送訊息給此使用者的文字要求使用者的使用者名稱。
message_timestamp_utc	items.last_message.message_timestamp_utc	string	文字要求傳送或接收訊息的時間戳記。
delivery_status	items.last_message.delivery_status	string	此訊息的目前狀態。 這可以是「發送」、「已交付」、「錯誤」或「發送」。
delivery_error	items.last_message.delivery_error	string	導致無法傳送此訊息的錯誤。 如果delivery_status不是 'error'，則此值將為 null。
mms_media	items.last_message.mms_media	array of string	指向此郵件附件的 URL 清單。 所有 url 都將是文本請求生成的 url。

取消封存對話

作業識別碼：

UnarchiveConversation

取消封存對話。 一旦對話取消存檔，它將再次出現在佇列中。 它也會出現在 /conversations 端點傳回的交談中。 如果交談已取消封存，則此方法無效。

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
對話電話號碼	phone_number	True	string	要存檔的對話的電話號碼。

傳回

response

string

取消指定的付款

作業識別碼：

CancelPayment

取消指定的付款，並傳送簡訊給使用者付款已取消。 付款無法編輯，因此取消並發放新付款是更正付款的最佳方式。

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
付款的 ID	payment_id	True	integer	要更新之付款的數字識別碼。

傳回

名稱	路徑	類型	Description
payment_id	payment_id	integer	付款的數字 ID。
request_date	request_date	string	此付款的初始訊息排入佇列等待傳送的時間戳記。
收件者	recipient	string	付款收件者的名稱。 如果聯絡人沒有與其電話號碼相關聯的姓名，則此值可能為空。
描述	description	string	付款說明。 這不會顯示給聯絡人。 它僅供內部使用者用於有關付款的上下文。
customer_phone	customer_phone	string	接收此付款的連絡人的電話號碼。
amount_requested	amount_requested	float	此付款要求的金額（以美元為單位）。
is_past_due	is_past_due	boolean	此付款是否超過請求日期。
reminder_was_sent	reminder_was_sent	boolean	是否已針對此付款發送文字提醒。
transaction_status	transaction_status	string	authvia 中交易的狀態。 此值開頭為 Unknown。
textrequest_payment_status	textrequest_payment_status	string	「文字要求」中的交易狀態。 這代表文字請求應用程式付款頁面中顯示的狀態。 它從「已發送」開始。
reference_number	reference_number	string	建立付款時定義的使用者定義 ID，可用來快速尋找付款。 參考編號不是唯一的;許多付款可以具有相同的參考。

大量更新聯絡人

作業識別碼：

BulkUpdateContacts

只有指定的儀表板才會新增聯絡人;聯絡人是按儀表板組織的，並且沒有帳戶層級搜尋可用的號碼。

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
聯絡電話	phone_number		string	要建立或更新的連絡人的電話號碼。
聯絡人的名字	first_name		string	連絡人的新名字。
聯絡人的姓氏	last_name		string	連絡人的新姓氏。
聯繫人的完整名稱	display_name		string	連絡人的新全名。 這是檢視聯絡人時 Web 應用程式中顯示的預設名稱。
是否隱藏來自此聯絡人的訊息	is_suppressed		boolean	決定是否隱藏與此連絡人的交談，因此在收到時不會推送到訊息佇列的頂端。
是否封存來自此聯絡人的訊息	is_archived		boolean	決定是否封存與此聯絡人的交談，因此在查詢交談時看不到 （預設）。
是否封鎖來自此聯絡人的訊息	is_blocked		boolean	判斷是否封鎖與此連絡人的交談，因此不會接收或儲存。
禁止此聯絡人的原因	suppressed_reason		string	描述抑制聯繫原因的短語。
聯絡說明	note		string	描述接觸的簡短短語。 為了方便起見。 這永遠不會顯示給聯絡人。
聯絡人群組	groups		array of integer	引用此聯絡人所屬群組的整數 ID 陣列。
聯絡標籤	contact_tags		array of string	參考附加至此連絡人的標籤的 GUID 陣列。
自訂欄位識別碼	id		string	Guid 參考自訂欄位。
自訂欄位值	value		string	此連絡人此自訂欄位的值。
目前與此連絡人的交談是否已解決	is_resolved		boolean	判斷是否已解決與此連絡人的目前交談。 此聯絡人收到的任何新簡訊都會設定此 false。

傳回

名稱	路徑	類型	Description
		array of object
電話號碼	phone_number	string	該聯絡人的電話號碼。
first_name	first_name	string	該聯絡人的名字。
last_name	last_name	string	此聯絡人的姓氏。
display_name	display_name	string	該聯絡人的全名。 這是檢視聯絡人時 Web 應用程式中顯示的預設名稱。
is_suppressed	is_suppressed	boolean	是否隱藏與此聯絡人的交談，因此在收到時不會推送到訊息佇列的頂端。
is_archived	is_archived	boolean	與此聯絡人的交談是否已封存，因此在查詢交談時無法看到 （預設）。
is_blocked	is_blocked	boolean	與此聯絡人的交談是否遭到封鎖，因此不會接收或儲存。
suppressed_reason	suppressed_reason	string	描述抑制聯繫原因的短語。 如果is_suppressed為 false，則為 null。
注意	note	string	描述接觸的簡短短語。 為了方便起見。 這永遠不會顯示給聯絡人。
groups	groups	array of integer	參考此聯絡人所屬群組的整數 ID 陣列。
contact_tags	contact_tags	array of string	參考附加至此連絡人的標籤的 GUID 陣列。
custom_fields	custom_fields	array of object	為此聯絡人定義的自訂欄位 ID 和值陣列。
識別碼	custom_fields.id	string	Guid 參考自訂欄位。
value	custom_fields.value	string	此連絡人此自訂欄位的值。
is_resolved	is_resolved	boolean	與此聯絡人的交談是否已解決。 此聯絡人收到的任何新簡訊都會設定此 false。
first_contact_utc	first_contact_utc	string	將第一則訊息傳送給此聯絡人的時間戳記。
opted_out_utc	opted_out_utc	string	此聯絡人選擇不接收訊息的時間戳記。
last_msg_sent_utc	last_msg_sent_utc	string	最後一則訊息傳送給此聯絡人的時間戳記。
last_msg_received_utc	last_msg_received_utc	string	從此聯絡人收到最後一則訊息的時間戳記。
total_msgs_sent	total_msgs_sent	integer	傳送給此聯絡人的訊息總數。
total_msgs_received	total_msgs_received	integer	從此聯絡人收到的訊息總數。
response_count	response_count	integer	來自聯絡人的回應訊息總數。
date_created_utc	date_created_utc	string	建立聯絡人的時間戳記。
last_contact_date_utc	last_contact_date_utc	string	從此聯絡人傳送或接收最後一則訊息的時間戳記。
message_id	last_message.message_id	string	訊息的 ID。 此值對於每則訊息都是唯一的。
body	last_message.body	string	此訊息的內容。
message_direction	last_message.message_direction	string	單數字元 R 或 S，分別表示此訊息是從聯絡人接收還是傳送給他們。
response_by_username	last_message.response_by_username	string	上次傳送訊息給此使用者的文字要求使用者的使用者名稱。
message_timestamp_utc	last_message.message_timestamp_utc	string	文字要求傳送或接收訊息的時間戳記。
delivery_status	last_message.delivery_status	string	此訊息的目前狀態。 這可以是「發送」、「已交付」、「錯誤」或「發送」。
delivery_error	last_message.delivery_error	string	導致無法傳送此訊息的錯誤。 如果delivery_status不是 'error'，則此值將為 null。
mms_media	last_message.mms_media	array of string	指向此郵件附件的 URL 清單。 所有 url 都將是文本請求生成的 url。

封存對話

作業識別碼：

ArchiveConversation

封存交談，將其從所有交談擷取端點的結果中移除。 如果客戶向您的簡訊請求號碼傳送簡訊，或您從簡訊請求號碼向客戶傳送簡訊，對話將自動取消封存。 存檔對話是消除您未來不打算與之交談的客戶的混亂的好方法。 請注意，如果客戶在“STOP”中發送短信以防止您向他們發送任何進一步的短信，則對話會自動存檔。

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
對話電話號碼	phone_number	True	string	要存檔的對話的電話號碼。

傳回

response

string

將付款標示為已付款

作業識別碼：

MarkPaymentPaid

將付款關閉為「已付款」。 當透過付款要求入口網站以外的方式支付付款時，請使用此端點。 這將關閉付款並將其付款金額添加到您的統計資料中。 透過文字請求傳送的付款入口網站支付的付款不需要此端點;這會自動將付款標記為已付款。

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
付款的 ID	payment_id	True	integer	要更新之付款的數字識別碼。

傳回

名稱	路徑	類型	Description
payment_id	payment_id	integer	付款的數字 ID。
request_date	request_date	string	此付款的初始訊息排入佇列等待傳送的時間戳記。
收件者	recipient	string	付款收件者的名稱。 如果聯絡人沒有與其電話號碼相關聯的姓名，則此值可能為空。
描述	description	string	付款說明。 這不會顯示給聯絡人。 它僅供內部使用者用於有關付款的上下文。
customer_phone	customer_phone	string	接收此付款的連絡人的電話號碼。
amount_requested	amount_requested	float	此付款要求的金額（以美元為單位）。
is_past_due	is_past_due	boolean	此付款是否超過請求日期。
reminder_was_sent	reminder_was_sent	boolean	是否已針對此付款發送文字提醒。
transaction_status	transaction_status	string	authvia 中交易的狀態。 此值開頭為 Unknown。
textrequest_payment_status	textrequest_payment_status	string	「文字要求」中的交易狀態。 這代表文字請求應用程式付款頁面中顯示的狀態。 它從「已發送」開始。
reference_number	reference_number	string	建立付款時定義的使用者定義 ID，可用來快速尋找付款。 參考編號不是唯一的;許多付款可以具有相同的參考。

建立或更新聯絡人

作業識別碼：

CreateContact

建立或更新聯絡人（取決於是否已經存在具有指定電話號碼的聯絡人）。

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
聯絡電話	phone_number	True	string	要建立或更新的連絡人的電話號碼。
聯絡人的名字	first_name		string	連絡人的新名字。
聯絡人的姓氏	last_name		string	連絡人的新姓氏。
聯繫人的完整名稱	display_name		string	連絡人的新全名。 這是檢視聯絡人時 Web 應用程式中顯示的預設名稱。
是否隱藏來自此聯絡人的訊息	is_suppressed		boolean	決定是否隱藏與此連絡人的交談，因此在收到時不會推送到訊息佇列的頂端。
是否封存來自此聯絡人的訊息	is_archived		boolean	決定是否封存與此聯絡人的交談，因此在查詢交談時看不到 （預設）。
是否封鎖來自此聯絡人的訊息	is_blocked		boolean	判斷是否封鎖與此連絡人的交談，因此不會接收或儲存。
禁止此聯絡人的原因	suppressed_reason		string	描述抑制聯繫原因的短語。
聯絡方式	note		string	描述接觸的簡短短語。 為了方便起見。 這永遠不會顯示給聯絡人。
聯絡人群組	groups		array of integer	引用此聯絡人所屬群組的整數 ID 陣列。
聯絡標籤	contact_tags		array of string	參考附加至此連絡人的標籤的 GUID 陣列。
自訂欄位識別碼	id		string	Guid 參考自訂欄位。
自訂欄位值	value		string	此連絡人此自訂欄位的值。
目前與此連絡人的交談是否已解決	is_resolved		boolean	判斷是否已解決與此連絡人的目前交談。 此聯絡人收到的任何新簡訊都會設定此 false。

傳回

名稱	路徑	類型	Description
電話號碼	phone_number	string	該聯絡人的電話號碼。
first_name	first_name	string	該聯絡人的名字。
last_name	last_name	string	此聯絡人的姓氏。
display_name	display_name	string	該聯絡人的全名。 這是檢視聯絡人時 Web 應用程式中顯示的預設名稱。
is_suppressed	is_suppressed	boolean	是否隱藏與此聯絡人的交談，因此在收到時不會推送到訊息佇列的頂端。
is_archived	is_archived	boolean	與此聯絡人的交談是否已封存，因此在查詢交談時無法看到 （預設）。
is_blocked	is_blocked	boolean	與此聯絡人的交談是否遭到封鎖，因此不會接收或儲存。
suppressed_reason	suppressed_reason	string	描述抑制聯繫原因的短語。 如果is_suppressed為 false，則為 null。
注意	note	string	描述接觸的簡短短語。 為了方便起見。 這永遠不會顯示給聯絡人。
groups	groups	array of integer	參考此聯絡人所屬群組的整數 ID 陣列。
contact_tags	contact_tags	array of string	參考附加至此連絡人的標籤的 GUID 陣列。
custom_fields	custom_fields	array of object	為此聯絡人定義的自訂欄位 ID 和值陣列。
識別碼	custom_fields.id	string	Guid 參考自訂欄位。
value	custom_fields.value	string	此連絡人此自訂欄位的值。
is_resolved	is_resolved	boolean	與此聯絡人的交談是否已解決。 此聯絡人收到的任何新簡訊都會設定此 false。
first_contact_utc	first_contact_utc	string	將第一則訊息傳送給此聯絡人的時間戳記。
opted_out_utc	opted_out_utc	string	此聯絡人選擇不接收訊息的時間戳記。
last_msg_sent_utc	last_msg_sent_utc	string	最後一則訊息傳送給此聯絡人的時間戳記。
last_msg_received_utc	last_msg_received_utc	string	從此聯絡人收到最後一則訊息的時間戳記。
total_msgs_sent	total_msgs_sent	integer	傳送給此聯絡人的訊息總數。
total_msgs_received	total_msgs_received	integer	從此聯絡人收到的訊息總數。
response_count	response_count	integer	來自聯絡人的回應訊息總數。
date_created_utc	date_created_utc	string	建立聯絡人的時間戳記。
last_contact_date_utc	last_contact_date_utc	string	從此聯絡人傳送或接收最後一則訊息的時間戳記。
message_id	last_message.message_id	string	訊息的 ID。 此值對於每則訊息都是唯一的。
body	last_message.body	string	此訊息的內容。
message_direction	last_message.message_direction	string	單數字元 R 或 S，分別表示此訊息是從聯絡人接收還是傳送給他們。
response_by_username	last_message.response_by_username	string	上次傳送訊息給此使用者的文字要求使用者的使用者名稱。
message_timestamp_utc	last_message.message_timestamp_utc	string	文字要求傳送或接收訊息的時間戳記。
delivery_status	last_message.delivery_status	string	此訊息的目前狀態。 這可以是「發送」、「已交付」、「錯誤」或「發送」。
delivery_error	last_message.delivery_error	string	導致無法傳送此訊息的錯誤。 如果delivery_status不是 'error'，則此值將為 null。
mms_media	last_message.mms_media	array of string	指向此郵件附件的 URL 清單。 所有 url 都將是文本請求生成的 url。

建立新的付款

作業識別碼：

CreatePayment

使用提供的訊息建立新的付款給提供的聯絡人。

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
付款說明	description		string	付款說明。 描述不會向聯絡人顯示，僅供內部使用者用於有關付款的上下文。
收件者電話號碼	customer_phone		string	此付款將發送到的聯絡人電話號碼。
請求金額（美元）	amount_requested		float	此付款要求的金額（以美元為單位）。
付款訊息文字內文	message		string	要發送給聯繫人的消息文本以及付款鏈接。
付款的參考字串	reference_number		string	建立付款時定義的使用者定義 ID，可用來快速尋找付款。 參考編號不是唯一的;許多付款可以具有相同的參考。

傳回

名稱	路徑	類型	Description
payment_id	payment_id	integer	付款的數字 ID。
request_date	request_date	string	此付款的初始訊息排入佇列等待傳送的時間戳記。
收件者	recipient	string	付款收件者的名稱。 如果聯絡人沒有與其電話號碼相關聯的姓名，則此值可能為空。
描述	description	string	付款說明。 這不會顯示給聯絡人。 它僅供內部使用者用於有關付款的上下文。
customer_phone	customer_phone	string	接收此付款的連絡人的電話號碼。
amount_requested	amount_requested	float	此付款要求的金額（以美元為單位）。
is_past_due	is_past_due	boolean	此付款是否超過請求日期。
reminder_was_sent	reminder_was_sent	boolean	是否已針對此付款發送文字提醒。
transaction_status	transaction_status	string	authvia 中交易的狀態。 此值開頭為 Unknown。
textrequest_payment_status	textrequest_payment_status	string	「文字要求」中的交易狀態。 這代表文字請求應用程式付款頁面中顯示的狀態。 它從「已發送」開始。
reference_number	reference_number	string	建立付款時定義的使用者定義 ID，可用來快速尋找付款。 參考編號不是唯一的;許多付款可以具有相同的參考。

建立新群組

作業識別碼：

CreateGroup

使用提供的名稱建立新群組。

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
群組名稱	name		string	群組的新名稱。
群組筆記	notes		string	描述群體的簡短短語。 為了方便起見。

傳回

名稱	路徑	類型	Description
識別碼	id	integer	群組的數字識別碼。
group_member_count	group_member_count	integer	群組的成員數目。
is_keyword	is_keyword	boolean	無論此群組是關鍵字群組。 當使用者設定關鍵字時，會自動產生此類群組。 聯絡人註冊時會自動新增。
名稱	name	string	此群組的名稱。
附註	notes	string	關於這個組的任何註釋。
last_message_sent_utc	last_message_sent_utc	string	為此群組傳送最後一次群組訊息的時間戳記。

更新特定儀表板的名稱

作業識別碼：

UpdateDashboardsName

更新儀表板。 這不會變更儀表板的電話號碼。 如果您想要一個包含另一個儀表板聯繫人的新號碼，則必須使用 POST 創建一個新儀表板，並通過批量導出/導入添加聯繫人。

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
儀表板名稱	name		string	儀表板的新名稱。

傳回

名稱	路徑	類型	Description
識別碼	id	integer	儀表板的數字識別碼。
名稱	name	string	儀錶板的名稱。
phone	phone	string	與此儀表板相關聯的簡訊號碼。

獲得所有付款

作業識別碼：

GetPayments

取得所有付款，包括已取消和已付款。 這些可以使用查詢參數進行過濾。

參數

名稱	機碼	必要	類型	Description
付款的參考字串	reference_number		string	建立付款時定義的使用者定義 ID，可用來快速尋找付款。 參考編號不是唯一的;許多付款可以具有相同的參考。
付款電話號碼	phone_number		string	此付款發送到的聯絡人的電話號碼。
排序依據	sort_type		string	要排序付款的屬性。 可以是“金額”、“聯繫人”、“日期”、“狀態”。
排序方向	sort_direction		string	對付款進行排序的方向。 可以是 “desc” 表示從最大到最小，或 “asc” 表示從小到最大。
要取得的編號頁	page	True	integer	要取得的實體頁面。 取得值時，每頁有最大大小，由page_size定義。 如果page大於最後一頁，則會傳回一個空陣列。
每頁要取得的每個實體數量	page_size	True	integer	要取得的每頁大小。 取得值時，這是每頁的最大大小，存取後續頁面由 page 引數完成。
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。

傳回

名稱	路徑	類型	Description
頁面	meta.page	integer	獲得的實體頁面。 此頁面中的實體數量由page_size定義。
page_size	meta.page_size	integer	此頁面中取得的實體數目。
total_items	meta.total_items	integer	資料庫中可用的實體數目，不論頁面大小或數目為何。 若要查看其他頁面，請變更請求中的頁碼。
items	items	array of object	從文字請求取得的付款實體清單。
payment_id	items.payment_id	integer	付款的數字 ID。
request_date	items.request_date	string	此付款的初始訊息排入佇列等待傳送的時間戳記。
收件者	items.recipient	string	付款收件者的名稱。 如果聯絡人沒有與其電話號碼相關聯的姓名，則此值可能為空。
描述	items.description	string	付款說明。 這不會顯示給聯絡人。 它僅供內部使用者用於有關付款的上下文。
customer_phone	items.customer_phone	string	接收此付款的連絡人的電話號碼。
amount_requested	items.amount_requested	float	此付款要求的金額（以美元為單位）。
is_past_due	items.is_past_due	boolean	此付款是否超過請求日期。
reminder_was_sent	items.reminder_was_sent	boolean	是否已針對此付款發送文字提醒。
transaction_status	items.transaction_status	string	authvia 中交易的狀態。 此值開頭為 Unknown。
textrequest_payment_status	items.textrequest_payment_status	string	「文字要求」中的交易狀態。 這代表文字請求應用程式付款頁面中顯示的狀態。 它從「已發送」開始。
reference_number	items.reference_number	string	建立付款時定義的使用者定義 ID，可用來快速尋找付款。 參考編號不是唯一的;許多付款可以具有相同的參考。

發送後續文本，提醒用戶支付指定的付款

作業識別碼：

SendPaymentReminder

傳送提醒給聯絡人支付指定的付款。 訊息的內容是自動產生的。 為避免垃圾郵件，每次付款只能發送一次提醒

參數

名稱	機碼	必要	類型	Description
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
付款的 ID	payment_id	True	integer	要更新之付款的數字識別碼。

傳回

名稱	路徑	類型	Description
payment_id	payment_id	integer	付款的數字 ID。
request_date	request_date	string	此付款的初始訊息排入佇列等待傳送的時間戳記。
收件者	recipient	string	付款收件者的名稱。 如果聯絡人沒有與其電話號碼相關聯的姓名，則此值可能為空。
描述	description	string	付款說明。 這不會顯示給聯絡人。 它僅供內部使用者用於有關付款的上下文。
customer_phone	customer_phone	string	接收此付款的連絡人的電話號碼。
amount_requested	amount_requested	float	此付款要求的金額（以美元為單位）。
is_past_due	is_past_due	boolean	此付款是否超過請求日期。
reminder_was_sent	reminder_was_sent	boolean	是否已針對此付款發送文字提醒。
transaction_status	transaction_status	string	authvia 中交易的狀態。 此值開頭為 Unknown。
textrequest_payment_status	textrequest_payment_status	string	「文字要求」中的交易狀態。 這代表文字請求應用程式付款頁面中顯示的狀態。 它從「已發送」開始。
reference_number	reference_number	string	建立付款時定義的使用者定義 ID，可用來快速尋找付款。 參考編號不是唯一的;許多付款可以具有相同的參考。

透過連絡人的電話號碼取得交談的訊息

作業識別碼：

GetMessagesByContactPhone

取得指定儀表板與電話號碼之間的交談。

參數

名稱	機碼	必要	類型	Description
要取得的編號頁	page	True	integer	要取得的實體頁面。 取得值時，每頁有最大大小，由page_size定義。 如果page大於最後一頁，則會傳回一個空陣列。
每頁要取得的每個實體數量	page_size	True	integer	要取得的每頁大小。 取得值時，這是每頁的最大大小，存取後續頁面由 page 引數完成。
儀表板的識別碼，以進行此呼叫	dashboard_id	True	integer	要處理的電話號碼儀表板。 單一帳戶可以有多個儀表板，代表客戶的不同電話線。
要搜尋的連絡人電話號碼	phone_number	True	string	要獲取消息的聯繫人的電話號碼。

傳回

名稱	路徑	類型	Description
頁面	meta.page	integer	獲得的實體頁面。 此頁面中的實體數量由page_size定義。
page_size	meta.page_size	integer	此頁面中取得的實體數目。
total_items	meta.total_items	integer	資料庫中可用的實體數目，不論頁面大小或數目為何。 若要查看其他頁面，請變更請求中的頁碼。
items	items	array of object	從文字要求取得的訊息實體清單。
message_id	items.message_id	string	訊息的 ID。 此值對於每則訊息都是唯一的。
body	items.body	string	此訊息的內容。
message_direction	items.message_direction	string	單數字元 R 或 S，分別表示此訊息是從聯絡人接收還是傳送給他們。
response_by_username	items.response_by_username	string	上次傳送訊息給此使用者的文字要求使用者的使用者名稱。
message_timestamp_utc	items.message_timestamp_utc	string	文字要求傳送或接收訊息的時間戳記。
delivery_status	items.delivery_status	string	此訊息的目前狀態。 這可以是「發送」、「已交付」、「錯誤」或「發送」。
delivery_error	items.delivery_error	string	導致無法傳送此訊息的錯誤。 如果delivery_status不是 'error'，則此值將為 null。
mms_media	items.mms_media	array of string	指向此郵件附件的 URL 清單。 所有 url 都將是文本請求生成的 url。

觸發程序

傳送或接收文字時觸發

傳送或接收文字時觸發

傳送或接收文字時觸發

作業識別碼：

TextingWebhook

傳送或接收文字時觸發

參數

名稱	機碼	必要	類型	Description
儀表板觸發器將接聽來自的事件	dashboard_id	True	string	要新增觸發程式的儀表板識別碼
事件	event	True	string	事件

傳回

名稱	路徑	類型	Description
訊息唯一識別碼	messageUniqueIdentifier	string	messageUniqueIdentifier
帳戶 ID	account.id	integer	識別碼
交談 Id	yourPhoneNumber.id	integer	識別碼
儀表板名稱	yourPhoneNumber.description	string	描述
儀表板電話號碼	yourPhoneNumber.phoneNumber	string	電話號碼
儀表板識別碼	conversation.id	integer	識別碼
date	conversation.date	string	date
聯絡電話	conversation.consumerPhoneNumber	string	消費者電話號碼
訊息方向	conversation.messageDirection	string	訊息方向
訊息	conversation.message	string	訊息
numSegments	conversation.numSegments	integer	numSegments
狀態	conversation.status	string	狀態
對話聲稱	conversation.claimedBy	string	聲稱者
連絡人顯示名稱	conversation.consumerFriendlyName	string	consumerFriendlyName

定義

字串

這是基本資料類型「string」。