Help Center/ Cognitive Engagement Center/ API Reference/ Web Client Access Interface Reference/ Creating a Click-to-Dial Call (createClickToCall)
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Creating a Click-to-Dial Call (createClickToCall)

Scenario

This interface is invoked to create a click-to-dial call.

Method

POST

URI

https://Domain name/apiaccess/ccmessaging/v1/createClickToCall (For example, the domain name is service.besclouds.com.)

Request

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

ccmessaging-token

String

No

Value of ccmessaging-token generated by the applyToken interface

2

x-app-key

String

No

App key, which is the user ID and is configured on the API Fabric

3

Authorization

String

No

Authentication field. The format is Bearer {Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.)
Table 2 Request body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

channel

String

Yes

Recipient channel type (WEB)

1.2

mediaAbility

String

Yes

Media capability

0: voice call

1: video call

Response

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

resultCode

String

No

Response result code

1.2

resultDesc

String

No

Response result description

If resultCode is 0, the operation is successful.

If resultCode is 13, the description is connect failed or No agents available currently.
  • Status code: 400

    Incorrect request. Check the request path and parameters.

  • Status code: 401

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

  • Status code: 404

    The requested content is not found. Check the request path.

  • Status code: 500

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

Error Code

None

Example

Request header: 
ccmessaging-token:eyJjcmVhdG*************NzIxMTc4  
Authorization:Bearer dbb0*************bbb33a  
x-app-key:6e9d9c*************152c2f6  
Content-Type:application/json

Request parameters:

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

Response parameters:

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