Help Center/ Cognitive Engagement Center/ API Reference/ Call Center Configuration Interface Reference/ Agent Management/ Changing the SIP Phone Number Login Password of an Agent (updateSipPhonePassword)
Updated on 2023-09-27 GMT+08:00
View PDF

Changing the SIP Phone Number Login Password of an Agent (updateSipPhonePassword)

Scenario

Change the login password of the SIP phone number of an agent. SIP phone numbers are OpenEye numbers used by agents or WebRTC registration numbers.

Method

POST

URI

https://Domain name/apiaccess/rest/cc-management/v1/sipPhone/updateSipPhonePassword. For example, the domain name is service.besclouds.com.

Request Description

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

x-app-key

String

No

App key field, which is the user ID. Contact the operation 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

requestParam

Object

Yes

Request parameter.

1.1

accountPwd

String

Yes

Current password of an agent. When the SIP phone password is changed, the current password of the agent needs to be input for verification. If the verification fails for three consecutive times, the account will be locked and will be unlocked 30 minutes later. You can also log in to the system as a tenant administrator to manually unlock the account.

1.2

newPhonePwd

String

Yes

New SIP phone password. The value is a string of 8 to 16 characters (default password rule group). By default, any combination of the following three types is required: uppercase letters, lowercase letters, digits, and the following special characters: ~@^*_+.?

1.3

userAccount

String

Yes

Agent account.

Response Description

  • Status code: 200
    Table 3 Response body parameters

    No.

    Parameter

    Type

    Mandatory or Not

    Description

    1

    schema

    Object

    Yes

    Successful request.

    1.1

    resultCode

    String

    Yes

    If the request is successful, the value is 0. If the request fails, the value is 1.

    1.2

    resultMessage

    String

    No

    When the request fails and the value of resultCode is 1, the specific cause is carried.
  • Status code: 400

    Incorrect request. Check the request path and parameters.

  • Status code: 401

    Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.

  • Status code: 404

    The requested content is not found. Check the request path.

  • Status code: 500

    Business failure. Check the values of parameters in the request.

Error Codes

None

Example

Scenario description: The SIP phone password is changed successfully.

Request parameters:

{
    "userAccount":"xxxxx",
    "accountPwd":"xxxxx",
	"newPhonePwd":"xxxxx"
}

Response parameters:

{
  "resultCode": "0",
  "resultMessage": "success"
}
Parent topic: Agent Management