POST /ccmessaging/v1/mobileagent/createcall

Updated on 2024-03-05 GMT+08:00

View PDF

Description

An operator logs in to the app and invokes the createcall interface provided by the Chat to create an anonymous outbound call task and initiates an anonymous call through the integrated SDK.

Method

POST

URI

https://Domain Name/apiaccess/ccmessaging/v1/mobileagent/createcall.For example,the domain name is service.besclouds.com.

Request

**Table 1** Header Parameters
Seq.	Name	Type	Mandatory	Description
1	X-APP-Key	string	True	The same as app_key, which uniquely identifies a user, Configuring the ApiFabric Tool
2	Authorization	string	True	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	called	string(32)	True	Called number
1.2	callData	string(1,024)	False	Call data
1.3	callerPresent	string(32)	True	Calling number, which is displayed by subscribers and customer managers. If the calling number is not contained, the default calling number of the platform is used.

Response

Status code: 200

**Table 3** Body Parameters
Seq.	Name	Type	Mandatory	Description
1.1	resultCode	string	True	Return Code. 0:success 30010000001:This feature is not enabled and cannot be used 30010000002:No SIP server information is found 30010000003:Input parameter verification failed 30010010001:Failed to add the outbound call task 30010010002:The VDN is unavailable 30010010003:The VDN configuration is incorrect, and the record path fails to be generated 30010019999:CCM other exception 30011010001:Failed to create a call without waiting for the call setup success event 30011019999:CCUCS other exception 30010009999:Chat other exception
1.2	resultDesc	string	False	Failure Cause Description
1.3	resultData	object	False	Response Data Structure
1.3.1	callSerialNo	string(50)	False	Call sequence number, which uniquely identifies an outgoing call
1.3.2	sipServiceAddress	string	True	IP address of the SIP service. The value is ip:port
1.3.3	accesscode	string	True	Used for anonymous VoIP calls. The value is the access code and UVID

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 the customer service personnel to check the current status of your account.
Status code: 404
Request not found: Check the request path.
Status code: 500
Service failure:Check the values of the parameters in the request.

Error Code

None.

Message Example

Scene description:Invoke the chat interface to create an outbound call task
URL:

Request Header:

{ "X-APP-Key": "b5cb838d-8b7a-4dc8-8aab-0b91edc7ec7b", "Authorization": "Bearer 1fea3651a3a09fa8489054bc3e1d6a15", "Content-Type": "application/json" }

Request Parameter:

{ "called":"88884432", "callData":"1", "callerPresent":"95599" }

Response Header:

connection →keep-alive content-encoding →gzip content-length →130 content-type →application/json;charset=UTF-8 date →Wed, 12 May 2021 08:52:40 GMT server →openresty

Response Parameter:

{ "resultCode": "0", "resultDesc": "Success", "resultData": { "sipServiceAddress": "10.137.203.215:5063", "accesscode": "179080024609291" } }