发送otp消息

通过API息发送otp号码池服务

• URL：https://api2.nxcloud.com/api/wa/otp
• Method：POST
• Content-Type：application/json
• 需要鉴权：是

鉴权机制

鉴权规则请参考地址：API接口调用约定

请求参数

header参数：

参数名	类型	必选	示例值	说明
accessKey	String	是	fme2na3kdi3ki	用户身份标识
ts	String	是	1655710885431	当前请求的时间戳（单位是毫秒），牛信服务端允许用户端请求最大时间误差为60秒
bizType	String	是	2	WhatsApp业务类型，取固定值“2”
action	String	是	mt	WhatsApp业务操作，取固定值“mt”
sign	String	是	6e9506557d1f289501d333ee2c365826	API入参参数签名，签名算法

body参数：

参数名	类型	必选	示例值	说明
appkey	String	是	pem28kje	应用appkey
messaging_product	String	是	whatsapp	发送消息的通道，应用于WhatsApp消息的发送时，值必须为“whatsapp”
recipient_type	String	是	individual	消息接收方类型，应用于WhatsApp消息的发送时，值必须为“individual”
to	String	是	86158xxxx1795	消息接收方的WhatsApp号码，需要带国码。如86158xxxx1795
content	String	是	189384	发送的消息验证码内容，4-8个连续的数字，如果有其他字符，则会提取验证码
language_code	String	是	en	使用指定的模板语言进行发送
cus_message_id	String	否	wamid.HBgLODUyNTUzMTE3MDUVAgARGBI	自定义消息id，将会在提交消息成功和消息状态回调里作为消息id返回，请保持全局唯一
dr_webhook	String	否	https://test.com/webhook	消息状态回调会优先推送到该地址，不填则推送到应用webhook上，webhook接口返回的http状态码必须为200
biz_opaque_callback_data	String	否		有助于追踪的任意字符串。例如，您可以在此字段中传递消息模板编号，以从您发送的第一条消息开始追踪客户体验历程。然后，您可以追踪不同消息模板类型的投资回报 (ROI)，以找出最有效的类型。 此字符串包含在 Webhooks 负载的 statuses 对象中，因此任何已在 WhatsApp Business 商业帐号中订阅 messages Webhooks 字段的应用均可获取此字符串。 此字段不会被处理，只会将其作为已发送/已送达/已读消息 Webhooks 的一部分返回。

请求示例

body（application/json） 参数：

{
    "appkey": "qlxxxaCM5",
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "xxx37446",
    "cus_message_id": "mmuud333dtee003444",
    "dr_webhook": "https://webhook.site/24b22cdd-bfa8-4ad2-aa3f-d2b9d510c9d9",
    "language_code": "en",
    "content": "789033"
}

响应参数

参数名	类型	说明
code	Integer	结果编码
data	JsonObject	请求结果
message	String	请求结果说明

发送成功

• data object参数：

参数名	类型	说明
messaging_product	String	通信通道类型
messages	array[message JsonObject]	消息序列

• message object参数：

参数名	类型	说明
id	String	系统生成的唯一的ID

响应示例

成功示例

{
    "code": 0,
    "message": "Success",
    "data": {
        "messaging_product": "whatsapp",
        "messages": [
            {
                "id": "wamid.18857e85eff8438caea378a54f1e9220"
            }
        ]
    },
    "traceId": "409038383a8a4812a82ccd7e3a6f33b5"
}

失败示例

{
    "code": 9003,
    "message": "Customer APP does not exist / Status is unavailable",
    "traceId": "5598e59e500d4a77b0c298be3ad81644"
}

响应码说明

code	message	解决办法
0	Success
-1	Failure	请联系技术人员排除问题
1000~100X	Authentication failed	详情查看API鉴权部分
1100	Customer does not exist / Status is unavailable	账号状态异常，联系业务人员处理账号问题
1102	Insufficient balance	账号余额不足，请联系业务人员充值
9000	Request parameter error	参数缺失，请检查必须的参数
9001	System business error	系统业务错误，请联系技术人员排除问题
9002	Phone number error	非法号码，请检查号码正确性
9003	Customer APP does not exist / Status is unavailable	应用状态异常（不存在/禁用），联系业务人员处理云平台应用创建/禁用问题
9004	Customer APP does not have quotation	应用没有对应国家报价，联系业务人员处理应用报价问题
9013	Customer APP does not have group	应用相关信息，联系业务人员处理应用报价问题
9014	Category does not exist	模板类型参数有误
9015	Content does not extract otp code	内容提取未提取到有效验证码，请核实内容
10003	WhatsApp business phone is not bind app	该whatsapp号码未绑定应用，请联系业务人员处理应用和手机号绑定操作
10005	WhatsApp Template does not exist or low quality	WhatsApp 模板不存在或者质量低

模板语言

语言	代码		语言	代码		语言	代码
Afrikaans	af		Greek	el		Portuguese (BR)	pt_BR
Albanian	sq		Gujarati	gu		Portuguese (POR)	pt_PT
Arabic	ar		Hebrew	he		Punjabi	pa
Azerbaijani	az		Hindi	hi		Romanian	ro
Bengali	bn		Hungarian	hu		Russian	ru
Bulgarian	bg		Indonesian	id		Serbian	sr
Catalan	ca		Irish	ga		Slovak	sk
Chinese (CHN)	zh_CN		Italian	it		Slovenian	sl
Chinese (HKG)	zh_HK		Japanese	ja		Spanish	es
Chinese (TAI)	zh_TW		Kannada	kn		Spanish (ARG)	es_AR
Croatian	hr		Kazakh	kk		Spanish (SPA)	es_ES
Czech	cs		Korean	ko		Spanish (MEX)	es_MX
Danish	da		Lao	lo		Swahili	sw
Dutch	nl		Latvian	lv		Swedish	sv
English	en		Lithuanian	lt		Tamil	ta
English (UK)	en_GB		Macedonian	mk		Telugu	te
English (US)	en_US		Malay	ms		Thai	th
Estonian	et		Marathi	mr		Turkish	tr
Filipino	fil		Norwegian	nb		Ukrainian	uk
Finnish	fi		Persian	fa		Urdu	ur
French	fr		Polish	pl		Uzbek	uz
German	de		Hausa	ha		Vietnamese	vi
Malayalam	ml		Zulu	zu