Help Center/ Cognitive Engagement Center/ User Access--Web Client Access (RESTful)/ Create Click-to-dial Call/ POST /ccmessaging/v1/createClickToCall
Updated on 2024-03-05 GMT+08:00
View PDF
Share

POST /ccmessaging/v1/createClickToCall

Description

create click to call

Method

POST

URI

https://Domain Name/apiaccess/ccmessaging/v1/createClickToCall,the domain name is service.besclouds.com.

Request

Table 1 Header Parameters

Seq.

Name

Type

Mandatory

Description

1

ccmessaging-token

string

False

ccmessagign-token generated by the applyToken interface

2

x-app-key

string

False

The same as app_key, which uniquely identifies a user

3

Authorization

string

False

Authentication field. The value format is as follows: Bearer +AccessToken in the return values of the tokenByAKSK interface (there is a space after Bearer)
Table 2 Body Parameters

Seq.

Name

Type

Mandatory

Description

1.1

channel

string

True

channel type ('WEB')

1.2

mediaAbility

string

True

mediaAbility:

0: audio call;

1: video call;

Response

  • Status code: 200
Table 3 Body Parameters

Seq.

Name

Type

Mandatory

Description

1.1

resultCode

string

False

result Code

1.2

resultDesc

string

False

result description
  • Status code: 400

    Incorrect request: Check the request path and parameters.

  • Status code: 401

    Unauthorized: 1. Check whether you have purchased related services. 2. Contact customer service personnel to check the current status of your account.

  • Status code: 404

    Request content not found: Check the path of the request.

  • Status code: 500

    Business failure: Check the values of the parameters in the request.

Error Code

None.

Message Example

  • Scene description:create voice call

    URL:create voice call

    Request Header:

    ccmessaging-token:eyJjcmVhdGVUaW1lIjoxNjA3MDc0NzIxMTc4 Authorization:Bearer dbb011d5df2b9466d20b0b1845bbb33a x-app-key:6e9d9cd8-e135-4ab8-9f78-88e6b152c2f6 Content-Type:application/json

    Request Parameter:

    { "channel":"WEB", "mediaAbility":"0" }

    Response Parameter:

    { "resultCode":"0", "resultDesc:":null }