Help Center/ Cognitive Engagement Center/ API Reference/ Agent Workbench Interface Reference/ Agent Control/ Call Control Interfaces: voicecall/ Querying Whether a Specified Agent Answers Calls on a Mobile Phone (isOfflineAgent)
Updated on 2023-09-27 GMT+08:00
View PDF

Querying Whether a Specified Agent Answers Calls on a Mobile Phone (isOfflineAgent)

Scenario

This interface is invoked to query whether a specified agent answers calls on a mobile phone.

Method

POST

URI

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

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 Parameters in the request body

No.

Parameter

Type

Mandatory or Not

Description

1.1

workNo

Number

Yes

Employee ID of an agent.

Response Description

  • Status code: 200
    Table 3 Parameters in the response body

    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.

    1.3

    data

    Boolean

    No

    Whether an agent answers calls on a mobile phone. The options are true (yes) and false (no).
  • 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",
    "data": false,
    "description": "success"
}