Check-in And Check-out Interface Description

1.Interface Introduction

Third-party systems can use this interface to set the agent to the offline answering state or check out from the login state in the customer's own system.

2.Interface request

• HTTP request method：POST

• Request url：{HOST}/v20160818/account/SignInOrOut/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 document：Interface authentication

3.The interface parameters are as follows: (red is a required parameter)

parameter	Is required	value	Description
sign	yes	SignIn / SignOut	Command name, the fixed name of the check-in interface is SignIn Command name, the fixed name of the checkout interface is SignOut
exten	yes	agent number	The seat number under the current account is generally 8000、8001、8002
ActionID	no	Unique string	Random code, which is used by the user to identify the requested operation. The server will return the corresponding ActionID; this field will be included in the call event; the maximum length of this field is 40 bytes
ExtenType	no	Local/gateway	This parameter is only available at check-in. ExtenType is not required. Do not pass this field to check in the mobile phone by default. The pass value can be Local or gateway. Local indicates that the phone is offline to answer, and gateway indicates that the sip phone is offline to answer.

Note: sip mode does not support check-in

4.System returns

Return JsonObject

{
    "Command": "Response",
    "Succeed": true,
    "ActionID": "SignIn0.41748595997299165",
    "Response": "SignIn"
}

Field description

parameter	value	Description
Response	SignIn	correspond Action The name
ActionID	Unique string	Unique tag for the operation
Succeed	process result	Whether the request was successful.Reason given in Message field
Message	Explanation of results	User has not bind gateway sip number or gateway sip number not register!：This agent has no registered sip number or is not bound to a sip number
Reason	301	This parameter is returned when checking out. Indicates that the agent is not offline and cannot be checked out