1 Interface overview

The third-party system needs to send an interface request to call the platform dialout function. Through this interface, the function of clicking dialout can be implemented in the customer's own system.

2 Interface request

• HTTP request method：POST

• Request url：{HOST}/v20160818/call/dialout/ACCOUNTID?sig=SIG

• When requesting, please replace {HOST} with connection data queryDomain name，ACCOUNTID is replaced with the account number, SIG is generated according to the authentication rules, please see the authentication document to see the specific generation rules

• Authentication method：Interface authentication

3 Interface parameters

parameter name	Is required	value	Parameter interpretation
FromExten	yes	Agent number	Example: Assuming 8001@gs is the agent login account, 8001 is the agent ID
Exten	yes	Called number	Called number; For the mobile phone number, the system will automatically determine whether it is a local number and automatically add 0 before the number. The user does not need to deal with it, just pass the mobile number, such as 138 ******** For fixed calls, if you are a foreign number user, you need to bring the area code, such as 010 ********
ExtenType	yes	Local/sip/gateway	When an outgoing call is made, the agent is forced to use this answering method to make an outgoing call. Local is "Mobile" and "gateway" is "Voice Gateway"
ActionID	no	Unique string (can be random)	Random code, used by the user to identify the requested operation. The Response returned by the server will carry the ActionID of the corresponding Action; this field will be included in the call event; the maximum length of this field is 40 bytes
DialoutStrVar	no	dialout custom parameters	Users can customize parameters in this field. This field will be pushed in event push. Support for pushing parameters in json format such asDialoutStrVar={ "name": "John" }

4 System returns

Returns Json object, example:

{
    "Response": "Dialout",
    "ActionID": "34534jh9i23",
    "Succeed": false,
    "Message": "401PBXnotfound"
}

Return value field description:

Field Name	value	Description
Response	Dialout	Corresponding Action Name
ActionID	Unique string	Unique tag for the operation
Succeed	process result	Whether the request was successful, and the reason will be given in the Message field when it is unsuccessful
Message	Explanation of results	400 Error action：Incorrect request, please check if the parameters passed are valid 401 PBX not found：Account configuration issues 403 Not allowed：The user account or verification code is invalid or expired, please technical support to modify the account properties to allow this account to use the dialout interface 403 forbbiden：Authentication failed 404 Agent not found：Agent not found, please check if the agent extension in the FromExten field is passed correctly 407 Agent can not take call: The agent cannot answer the phone (the agent is not logged in) 408 Agent Busy：The agent is busy and cannot answer (the agent already has a call in progress). If it is the gateway mode, it may be that the phone is out of registration, please check the phone status 409 Agent extenType not available：The answer method specified by the caller is unavailable. Possible reasons: the softphone is not logged in, the gateway is not bound or registered, and the mobile phone number is not bound 500 Server error：Server Error