Help Center/ Cognitive Engagement Center/ API Reference/ Agent Workbench Interface Reference/ Agent Control/ Call Control Interfaces: voicecall/ Exiting the Function of Answering Calls on a Mobile Phone (logout)
Updated on 2023-09-27 GMT+08:00
View PDF

Exiting the Function of Answering Calls on a Mobile Phone (logout)

Scenario

This interface is invoked to sign out of an offline agent when the Shift Mobile function is used.

Method

POST

URI

https://Domain name/apiaccess/rest/cc-management/v1/offline/agent/logout

Request Description

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

X-APP-KEY

String

No

App key, which is the user ID. Contact operations personnel to obtain the app key.

2

Authorization

String

Yes

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

workNo

Number

Yes

Employee ID of an agent.

Response Description

  • Status code: 200
    Table 3 Response body parameters

    No.

    Parameter

    Type

    Mandatory or Not

    Description

    1.1

    returnCode

    String

    Yes

    Operation result. The value 0 indicates success, and other values indicates failure.

    1.2

    description

    String

    No

    Prompt message.
  • Status code: 401

    Authentication failed.

  • Status code: 404

    The requested resource does not exist.

  • Status code: 500

    Internal server error.

Error Codes

None

Example

Request header:

Content-Type:application/json
X-APP-KEY:*********************
Authorization:Bearer *********************

Request parameters:

{"workNo":107}

Response parameters:

{
    "returnCode": "0",
    "description": "success"
}