ZOLOZZOLOZDOCS

SendMessage

概览

  • API URL：/api/v1/zoloz/globalchatapp/sendmessage
  • API 描述：该接口用于将指定的消息内容通过指定的Chatapp渠道发送给指定的手机号码。

请求参数

字段名称

数据类型

最大长度

是否必填

默认值

描述

示例值

channelType

String

32

是

-

渠道类型，固定值为VIBER。

"VIBER"

sender

String

64

是

-

指定消息发送人。

"ZOLOZViber"

mobile

String

32

是

-

接收消息的手机号码，格式为“国际区号+号码”。

"6321245567****"

contentType

String

32

是

-

消息类型。取值：

  • template：发送Chatapp Messages时，需使用已审核通过的消息模板。

"template"

templateCode

String

64

否

null

需要发送的消息模板Code。

"VIBER_10000691"

templateLanguage

String

32

否

null

消息模板语言。

"en_US"

templateParams

Java.util.Map

-

否

null

消息模板内的可用变量参数和对应值。

参考请求示例

field

String

-

否

null

templateParams的子类型。

参考请求示例

group

Long

-

是

-

产品规则ID，具体请与ZOLOZ对接人员沟通。

60006

返回参数

字段名称

数据类型

必须返回

描述

示例值

result

Result

是

API请求结果，包含结果状态、结果码和结果消息。

{        

"resultStatus": "S",        "resultCode": "SUCCESS",        "resultMessage": "Success"    

}

transactionId

String

否

ZOLOZ服务器生成的唯一事务ID。

说明：仅当交易进入处理阶段后系统才会返回transactionId。如果在开始处理交易之前发生错误，系统不会返回transactionId。包括但不限于以下情况：

  • 请求参数非法，例如入参格式错误或缺失必传参数。
  • 请求未能成功到达服务器，例如网络问题或网关故障。
  • 系统限流导致请求被拒绝。

"G0062000061MT20230325dAqiXBpQUbVB9h****"

处理结果

根据请求结果执行下一步的响应动作，具体如下：

  • 当result.resultStatus的值为S时，表示调用ZOLOZ Global Chatapp SendMessage API成功。
  • 当result.resultStatus的值为F时，表示调用ZOLOZ Global Chatapp SendMessage API失败。请检查错误码获取有关该错误的更多信息，并分析导致该错误的原因。

API通用结果码

有关通用结果码的完整列表，请参见API通用结果码。

代码示例

请求示例

copy
{
    "channelType": "VIBER", 
    "sender": "ZOLOZViber", 
    "mobile": "6321245567****", 
    "contentType": "template", 
    "templateCode": "VIBER_10000691", 
    "templateLanguage": "en_US", 
    "templateParams": {
        "params1": "这是变量params1的具体值", 
        "params2": "这是变量params2的具体值", 
        "verificationCode": "1234"
    }, 
    "group": 60006
}

返回示例

copy
{
    "result": {
        "resultStatus": "S", 
        "resultCode": "SUCCESS", 
        "resultMessage": "Success"
    }, 
    "transactionId": "G0062000061MT20230325dAqiXBpQUbVB9h****"
}