forked from nxtele/http-api-document
-
Notifications
You must be signed in to change notification settings - Fork 1
发送语音通知
ben.zhuang edited this page Oct 14, 2022
·
1 revision
简要描述:
- 语音通知接口
请求URL:
http://api.nxcloud.com/api/voiceSms/notsend
请求方式:
- POST ,以HTTP FORM 表单格式提交
- Content-Type: application/x-www-form-urlencoded
参数:
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appkey | 是 | string | 语音应用appkey |
| secretkey | 是 | string | 语音应用secretkey |
| phone | 是 | string | 手机号,能批量提交,多个号码以逗号隔开(,) |
| country_code | 是 | string | 国码(不带+号,纯国码数字即可) |
| show_phone | 是 | string | 想要显示的号码(填写任意位数的数字即可,实际显示号码可能会被修改) |
| content | 是 | string | 文字内容;如需播报验证码则数字之间用'-'隔开,比如:1-2-3-4-5-6;内容需要做urlencode(utf-8) |
| lang | 是 | string | 语言代码(参照下列表格), zh(Chinese),只传缩写英文如:zh、en |
返回示例
{"result":"请求成功","messageid":"20d6c660bd664c65bef20026564b0b79","code":"0"}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| result | string | 请求结果说明 |
| messageid | string | 系统返回的语音ID |
| code | string | 结果编码 |
备注
- 语言代码
| code | 说明 |
|---|---|
| zh | Chinese |
| zh-yue | Chinese-粤语 |
| en | English |
| id | Indonesian |
| vi | Vietnamese |
| km | Cambodian |
| th | Thai |
| ar | Arabic |
| tr | Turkish |
| ru | Russian |
| de | German |
| fr | French |
| it | Italian |
| pt | Portuguese |
| hi | India |
| es | Spanish |
- 错误代码
| code | 说明 |
|---|---|
| 0 | 请求成功 |
| 1 | 应用不可用或key错误 |
| 2 | 参数错误或为空 |
| 3 | 余额不足 |
| 4 | 内容为空或包含非法关键词 |
| 5 | 内容过长 |
| 6 | 号码有误 |
| 9 | IP非法 |
| 20 | url不存在 |
| 21 | 显示号码有误 |
| 22 | 路由未开通 |
| 23 | 国码有误 |
| 88 | 请求失败 |
| 99 | 系统错误 |
Introduction
- Send Message
- Mark Incoming Message as Read
- Upload Media File
- Get Media File
- Delete Media File
- Webhook
- Query Number Information
- Query Message Template
- Create Message Template
- Edit Message Template
- Delete Message Template
- Upload Template Example File
- Embedded Page Login
- Create Client Application
- List of Phone Numbers for Client Application
- Get Verification Code
- Verify Verification Code
- Create Local Client
Short message
Voice
Call Center(NXLink)
- Web Iframe
- Manual Dial Record
- Manual Dial Record Query By orderId
- List Agent Information
- List Agent Status
- List Queue
- List Agents In Queue
- List Agent Efficiency
- Update Queue Agents
- Create AutoDial Task
- Webhook - Manual Dial
AI Agent(NXLink)
- AI Agent Task List
- Query Call Records
- Append Contacts to an Existing Task
- Delete Contacts
- Call Record Callback
Call Center(Callbot)
- Callbot API Summary
- Callbot API Authorization
- Callbot API Ping
- Create Auto Dial Task
- Add Contact List To Task
- Create Task And Add Contact
- Start Or Pause Task
- Update Task Parameters
- Get List Task
- List Call
- List Task Orders
- Stop Order
- Get Call Detail By Order
- Webhook - By Call
- Webhook - By Order
- Webhook - Task Status
Flash Call
Short links
邮件验证码
DID号码
通用
号码检测