对接文档

文件通知外呼

POST

/dail/invite_play_file

视频通知外呼接口，请求方式POST，需要签名才可调用，请求参数见下方参数说明，此接口请求为单向视频请求，接通后无需手机终端开启本地视频。如被叫手机不支持VoLTE视频通话功能，则自动切换为语音通知模式。

请求参数

Header 参数

appId

string

由运营人员提供

必需

accessKey

string

由运营人员提供

必需

timestamp

string

请求当前时间戳

必需

signature

string

请求签名

必需

Body 参数application/json

caller_name

string

主叫名称

可选

caller_number

string

主叫号码

可选

call_type

string

可选

呼叫类型（audio、video）

fileId

string

可选

视频文件ID，文件上传接口返回值

fileUrl

string

可选

视频文件访问地址(当fileId和fileUrl同时有值时，优先使用fileId)

calleeDataArray

array [object {2}]

被叫用户组

必需

callId

string

被叫用户ID或名称

必需

callee

string

被叫号码

必需

示例

{
  "caller_name": "101255****",
  "caller_number": "101255****",
  "fileId": "MTI4MC5tcDQ=",
  "calleeDataArray": [
    {
      "callId": "20241219001",
      "callee": "177******26"
    },
    {
      "callId": "20241219002",
      "callee": "181******59"
    }
  ]
}

示例代码

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_file' \
--header 'appId;' \
--header 'accessKey;' \
--header 'timestamp;' \
--header 'signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "caller_name": "101255****",
    "caller_number": "101255****",
    "fileId": "MTI4MC5tcDQ=",
    "calleeDataArray": [
        {
            "callId": "20241219001",
            "callee": "177******26"
        },
        {
            "callId": "20241219002",
            "callee": "181******59"
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

code

string

必需

message

string

必需

data

必需

示例

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

🔴500缺少认证信息

🔴500认证信息过期

修改于 2024-12-27 02:54:44

IVVR外呼

语音验证码外呼