IVVR外呼

POST

/dail/invite_ivvr

IVVR外呼接口，请求方式POST，需要签名才可调用，请求参数见下方参数说明。此接口支持双向视频请求和单项视频请求，请求参数中video_sendonly设置为true时，为视频单向请求呼叫，缺失或false为视频双向请求，当被叫手机支持VoLTE通话时，接通后进入视频IVVR，可根据IVVR提示进行后续操作；当被叫手机不支持VoLTE视频通话时，接通后接入语音IVR。

请求参数

Header 参数

appId

string

由运营人员提供

必需

accessKey

string

由运营人员提供

必需

timestamp

string

请求当前时间戳

必需

signature

string

请求签名

必需

Body 参数application/json

caller_name

string

主叫名称

可选

caller_number

string

主叫号码

可选

call_type

string

可选

呼叫类型（audio、video）

video_sendonly

boolean

可选

是否为视频单向呼叫，缺失双向呼叫

calleeDataArray

array [object {2}]

被叫号码组

必需

callId

string

被叫ID或名称

必需

callee

string

被叫号码

必需

示例

{
  "caller_name": "101255****",
  "caller_number": "101255****",
  "calleeDataArray": [
    {
      "callId": "20241219004",
      "callee": "139*****49"
    },
    {
      "callId": "20241219002",
      "callee": "186******49"
    }
  ]
}

示例代码

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_ivvr' \
--header 'appId;' \
--header 'accessKey;' \
--header 'timestamp;' \
--header 'signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "caller_name": "101255****",
    "caller_number": "101255****",
    "calleeDataArray": [
        {
            "callId": "20241219004",
            "callee": "139*****49"
        },
        {
            "callId": "20241219002",
            "callee": "186******49"
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

code

string

必需

message

string

必需

data

必需

示例

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

🔴500缺少认证信息

🔴500认证信息过期

修改于 2024-12-28 02:39:10

文件通知外呼