对接文档

语音验证码外呼

POST

/dail/invite_play_code

语音验证码外呼接口，请求方式POST，需要签名才可调用，请求参数见下方参数说明，此接口请求为语音呼叫请求，可通过参数设置语音验证码播放次数。

请求参数

Header 参数

appId

string

由运营人员提供

必需

accessKey

string

由运营人员提供

必需

timestamp

string

请求当前时间戳

必需

signature

string

请求签名

必需

Body 参数application/json

caller_name

string

主叫名称

可选

caller_number

string

主叫号码

可选

callId

string

呼叫ID

必需

callee

string

被叫号码

必需

code

string

必需

验证码（4～6位数字）

times

integer

必需

播放次数（最大不超过3次）

示例

{
  "caller_name": "101255****",
  "caller_number": "101255****",
  "callId": "20241219001",
  "callee": "177******26",
  "code": "0965",
  "times": "2"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://vcc.scmeeting.com:9090/api/v1/dail/invite_play_code' \
--header 'appId;' \
--header 'accessKey;' \
--header 'timestamp;' \
--header 'signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "caller_name": "101255****",
    "caller_number": "101255****",
    "callId": "20241219001",
    "callee": "177******26",
    "code": "0965",
    "times": "2"
      
   
}'

返回响应

🟢200成功

application/json

Body

code

string

必需

message

string

必需

data

必需

示例

{
  "code": "0000",
  "message": "SUCCESS",
  "data": {}
}

🔴500缺少认证信息

🔴500认证信息过期

修改于 2025-03-18 03:52:12

文件通知外呼