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

Answering Calls on a Mobile Phone (login)

Scenario

The function of answering calls on a mobile If an agent cannot answer customers' calls on the agent workbench on the PC, the agent can click Shift Mobile to bind a mobile phone to answer calls on the mobile phone. Real and available numbers are supported, such as a mobile number or fixed-line phone number.

Method

POST

URI

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

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

phone

String

Yes

Number used for answering calls (real and available number, such as a mobile number or fixed-line phone number).

1.2

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.

    1.3

    restTime

    String

    No

    Rest duration, in seconds.

    1.4

    agentType

    String

    No

    Agent type. The options are 4 (voice agent), 5 (multimedia agent), 11 (video agent), and 99 (versatile agent).

    1.5

    forceLogin

    Boolean

    No

    Whether to enable forcible sign-in. The options are true (yes) and false (no).

    1.6

    isAutoAnswer

    Boolean

    No

    Whether to enable automatic call answering. The options are true (yes) and false (no).

    1.7

    videoMode

    Number

    No

    Video application mode. The options are 0 (SFU video), 1 (MCU video), and 2 (SFU+MCU video).

    1.8

    workNo

    Number

    No

    Employee ID of an agent.

    1.9

    isMultiChannelSupport

    Boolean

    No

    Whether to enable multi-channel sign-in. The options are true (yes) and false (no).

    1.10

    skills

    Array [Object]

    No

    Skill queue list.

    1.10.1

    skillId

    Number

    No

    Skill queue ID.

    1.10.2

    mediaTypeId

    String

    No

    Media type. The options are 5 (voice), 53 (multimedia), 19 (video), 2 (voice click-to-dial), and 18 (video click-to-dial).
  • 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:

{"phone":"13800000000","workNo":107}

Response parameters:

{
    "restTime": "",
    "agentType": "4",
    "forceLogin": true,
    "isAutoAnswer": "true",
    "description": "success",
    "videoMode": 0,
    "workNo": 107,
    "skills": [
        {
            "skillId": 4,
            "mediaTypeId": "5"
        }
    ],
    "returnCode": "0",
    "isMultiChannelSupport": false
}