外呼参与人

外呼参与人

1. 接口描述

接口名称:

/conference/conference/dialoutConference

发送方式:

POST

参数格式:

accept: application/json;content-type: application/json

2. 输入参数

参数名 必选 类型 说明
appKey string 认证用的唯一标识,整合时提供
billingCode string 外呼参会人加入的会议billingCode ,(注意:billingCode不传递时,passCode需要传递)
passCode string 支持使用主持人密码外呼,(注意:passCode不传递时,billingCode需要传递)
userId int 主持人userId
email string 主持人email
callbackUrl string 回调地址,参会人状态变化时主动调用的回调地址
partyList string 需要召集的参会人列表

partyList 参数:

参数名 必选 类型 说明
userId string 被呼叫人的UserId
phone string 电话号码,国际码+区号+电话,比如(86)1059933636, (86)1059933636-3636, (86)138xxxxxxxx
role int 入会角色, 1主持人 0参与人
PartyType int 默认0
partyId string 默认空
status int 默认0
userSiteID int 默认0
callSeq string 默认空

3. 示例

传参示例

{
    "appKey": "598c2c48555672a3579e0c678d395782",
    "billingCode": "93710066",
    "callbackUrl": "http://oncloudb.quanshi.com/uniform/callback/telconference",
    "partyList": [{
        "userId": 81299515,
        "phone": "S(86)15950095725",
        "role": 1,
        "PartyType": 0,
        "partyId": "",
        "status": 0,
        "userSiteID": 0,
        "callSeq": ""
    }],
    "userId": 87621760
}

返回示例

{
    "status": 0,
    "result": [{
        "userId": 81299515,
        "phone": "S(86)15950095725",
        "role": 1,
        "PartyType": 0,
        "partyId": "1597745746667YY10000",
        "status": 0,
        "userSiteID": 0,
        "callSeq": ""
    }],
    "request_id": "confopenapiserver-192.168.28.45-1597745745.586090420.425",
    "timestamp": 1597745745586,
    "callSeq": "93710066-1597745602645",
    "content_type": "application/json",
    "request_duration": "1.520134192s"
}

4. 返回参数

参数名 类型 说明
status int 0:成功,非0失败
result json字符串 外呼返回结果
userId int 主持人userId
phone string 外呼手机号
role int 入会角色, 1主持人 0参与人
PartyType int 入会角色, 1主持人 0参与人
partyId string 外呼的唯一ID
status int 外呼状态0
userSiteID int userSiteID
callSeq string 默认空

备注

  • 更多返回错误代码请看首页的错误代码描述