全部產品
Search

搜尋本產品

    Chat App Message Service：SendChatappMessage - 發送ChatApp訊息

    文件中心

    Chat App Message Service：SendChatappMessage - 發送ChatApp訊息

    更新時間：Nov 09, 2025

    發送ChatApp訊息。

    介面說明

    QPS 限制

    本介面的單使用者 QPS 限制為 250 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。

    狀態變更

    訊息發送狀態可以通過 MNS/HTTP 方式監聽，具體請參考回執訊息。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cams:SendChatappMessage

    create

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ChannelType

    string

    是

    通道類型。取值：

    • whatsapp。

    • messenger。

    • instagram。

    • viber。

    whatsapp
    Type

    string

    是

    訊息類型。取值：

    • template：在控制台已被審核通過的訊息模板，可以在任意時間發送。

    • message：任意格式的訊息，時間限制為在收到使用者最後一條訊息後的 24 小時內可發送此類訊息。

    重要 當 Type 為 template 時，必須設定 TemplateCode；當 Type 為 message 時，必須設定 MessageType。

    message
    MessageType

    string

    否

    當 Type 為 message 時，指定訊息的詳細類型。取值：

    • text：純文字訊息，設定此類型時 Content 欄位中的 Text 參數為必填。

    • image：圖片訊息，設定此類型時 Content 欄位中的 Link 參數為必填，Caption 參數為選填。

    • video：影像訊息，設定此類型時 Content 欄位中的 Link 參數為必填，Caption 參數為選填。

    • audio：音頻訊息，設定此類型時 Content 欄位中的 Link 參數為必填，Caption 參數則無效。

    • document：文檔訊息，設定此類型時 Content 欄位中的 Link 參數及 FileName 參數為必填，Caption 參數則無效。

    text
    TemplateCode

    string

    否

    模板編碼。通道管理>管理>模板設計介面查看模板編碼。

    1119***************

    Language

    string

    否

    語言。詳細語言代碼清單，請參見語言代碼。

    en
    From

    string

    是

    發送方號碼。

    • 當 ChannelType 為 whatsapp 時為註冊並綁定 WhatsApp 的電話號碼。在通道管理>管理>WABA 管理>號碼管理介面查看。

    • 當 ChannelType 為 messenger 時為公用首頁 ID（Page ID）。在通道管理>管理>公用首頁介面查看。

    • 當 ChannelType 為 instagram 時為 instagram 專業賬戶 ID（Account ID）。在通道管理>管理>專業賬戶介面查看。

    • 當 ChannelType 為 viber 時為 Viber 服務號 ID（Service ID）。在通道管理>管理>服務號管理介面查看。

    861387777****
    To

    string

    是

    接收方號碼。

    • 當 ChannelType 為 whatapp 時為訊息接收方的電話號碼。

    • 當 ChannelType 為 messenger 為與 Facebook 頁面訊息互動時產生的一個 Page-Scoped User ID。

    • 當 ChannelType 為 instagram 時為使用者與 Instagram 商業帳號或創作者帳號訊息互動時產生的 Instagram User ID。

    • 當 ChannelType 為 viber 時為訊息接收方的電話號碼。

    861388988****
    TemplateParams

    object

    否

    模板參數集合。

    string

    否

    模板參數。Key-Value 格式，Key 為參數名稱，Value 為參數取值。

    { "param1": "value1", "param2": "value2" }
    Content

    string

    否

    訊息內容。

    WhatsApp 訊息備忘：

    • 當 messageType 為 text 時，text 欄位為必填，Caption 禁止填寫。

    • 當 messageType 為 image 時，Link 必填。

    • 當 messageType 為 video 時，Link 必填。

    • 當 messageType 為 audio 時，Link 必填，Caption 欄位無效。

    • 當 messageType 為 document 時，Link 和 FileName 欄位必填，Caption 欄位無效。

    • 當 messageType 為 interactive 時，type 和 action 欄位必填。

    • 當 messageType 為 contacts 時，name 欄位必填。

    • 當 messageType 為 location 時，longitude 和 latitude 欄位必填。

    • 當 messageType 為 sticker 時，Link 欄位必填，Caption 和 FileName 欄位無效。

    • 當 messageType 為 reaction 時，messageId 和 emoji 欄位必填。

    Messenger 訊息備忘：

    • 當 messageType 為 text 時，text 欄位必填。

    • 當 messageType 為 image、video、audio、document 時，link 欄位必填。

    Instagram 訊息備忘：

    • 當 messageType 為 text 時，text 欄位必填。

    • 當 messageType 為 image、video、audio 時，link 欄位必填。

    Viber 訊息備忘：

    • 當 messageType 為 text 時，text 欄位必填。

    • 當 messageType 為 image 時，link 欄位必填。

    • 當 messageType 為 video 時，link、thumbnail、fileSize、duration 欄位必填。

    • 當 messageType 為 document、link、fileName、fileType 欄位為必填。

    • 當 messageType 為text_button時，text、caption、action 欄位為必填。

    • 當 messageType 為text_image_button時，text、link、caption、action 欄位為必填。

    • 當 messageType 為text_video時，text、link、thumbnail、fileSize、duration 欄位為必填。

    • 當 messageType 為text_video_button時，text、link、thumbnail、fileSize、duration、caption 欄位為必填，action 欄位不能為值。

    { "text": "hello,whatsapp", "link": "https://*******", "caption": "****", "fileName": "****" }
    Payload

    array

    否

    按鈕的觸發訊息集合。

    payloadtext1,payloadtext2,payloadtext3

    string

    否

    模板中按鈕的觸發訊息。

    payloadtext

    CustWabaId deprecated

    string

    否

    ISV 客戶 wabaId。 過時的參數，請使用 CustSpaceId，直客客戶執行個體 ID。在通道管理>介面查看。

    cams-8c8*********

    FallBackId

    string

    否

    回落策略 ID。該參數為國際站配置參數，中國站可忽略此參數。在回落策略介面查看策略 ID。

    S0****
    FallBackContent

    string

    否

    自訂回落內容。該參數為國際站配置參數，中國站可忽略此參數。

    Fallback SMS
    IsvCode deprecated

    string

    否

    ISV 校正碼，用於校正子帳號是否由 ISV 授權，已棄用，可忽略此參數。

    123123******
    CustSpaceId

    string

    否

    ISV 子客戶的 SpaceId ，直客客戶執行個體 ID。在通道管理介面查看。

    cams-8c8*********

    ContextMessageId

    string

    否

    回複的訊息 ID。指原來已發送過或者收到的訊息 ID。

    61851ccb2f1365b16aee****

    TrackingData

    string

    否

    Viber 訊息類型傳入的自訂追蹤資料，此參數為國際站參數，中國站可忽略此參數

    Tracking Data
    Label

    string

    否

    Viber 訊息類型，此參數為國際站參數，中國站可忽略此參數。 取值：

    • pormotion：營銷、促銷類訊息。

    • transaction：通知類訊息。

    promotion
    Ttl

    integer

    否

    Viber 訊息發送逾時時間。此參數為國際站參數，中國站可忽略此參數。單位：秒，取值範圍 30~1209600。

    50
    Tag

    string

    否

    標籤資訊，Viber 訊息發送時自訂標籤資訊。

    tag
    TaskId

    string

    否

    自訂任務 ID。

    10000****
    FallBackDuration

    integer

    否

    回落觸發時間。此參數為國際站參數，中國站可忽略此參數。訊息在指定時間內沒有返回已到達回執訊息時進行回落, 不填代表不根據此時間判斷回落，只有發送失敗和有失敗的狀態報表時才會回落。單位：秒。最小值：60，最大值：43200。

    120
    ProductAction

    object

    否

    商品資訊，此參數只針對於 whatsapp 類型通道。即為您在 Meta 上上傳的商品資訊。

    ThumbnailProductRetailerId

    string

    否

    商品目錄 ID。可通過 ListProductCatalog 介面擷取。

    skkks99****
    Sections

    array<object>

    否

    商品分類列表（最多可以有 10 個分類，30 個商品）。

    array<object>

    否

    商品分類。

    Title

    string

    否

    分類名稱。在通道管理>管理>目錄管理>商品管理介面查看或通過 ListProduct 介面擷取。

    abcd
    ProductItems

    array<object>

    否

    商品資訊列表。

    object

    否

    商品資訊。

    ProductRetailerId

    string

    否

    商品 ID。在通道管理>管理>目錄管理>商品管理介面查看或通過 ListProduct 介面擷取。

    ksi3****
    FallBackRule

    string

    否

    回落規則。此參數為國際站參數，中國站可忽略此參數。 取值：

    • undelivered：訊息不能發送到端時進行回落（在發送狀態時模板、參數需要校正通過，模板被封、號碼被封等不做校正）。參數值為空白時預設使用此規則。

    • sentFailed：訊息在校正模板、模板變數等參數時，校正不通過也會進行回落。只會強校正 channelType, type, messageType, to, from(是否存在) 幾個參數。

    undelivered
    FlowAction

    object

    否

    Flow 訊息對象。

    FlowToken

    string

    否

    自訂 flow token 資訊。

    kde****
    FlowActionData

    object

    否

    flow 預設參數集合。

    string

    否

    flow 預設參數。Key-Value 格式，Key 為參數名稱，Value 為參數取值。

    { "name": "name" }
    TemplateName

    string

    否

    模板名稱。在通道管理>管理>模板設計介面查看模板名稱。

    test_name

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回資料。

    RequestId

    string

    請求 ID。

    90E63D28-E31D-1EB2-8939-A94866******
    Code

    string

    請求狀態代碼。

    • 返回 OK 代表請求成功。

    • 其他錯誤碼，請參見錯誤碼列表。

    OK
    Message

    string

    錯誤提示資訊。

    User not authorized to operate on the specified resource.
    MessageId

    string

    訊息 ID。

    61851ccb2f1365b16aee****

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866******",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "MessageId": "61851ccb2f1365b16aee****"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 Product.Unsubscript You have not subscribed to the specified product. 您尚未訂閱指定的產品。
    400 Ram.PermissionDeny You are not authorized to perform the operation. 您無權執行該操作。
    400 System.LimitControl The system is under flow control. 系統處於流量控制之下。
    400 Unknown.ResourceOwnerId The resource does not belong to the current user. 資源不屬於目前使用者。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。