GetChatRoutingProfile

更新时间:
复制 MD 格式

Use GetChatRoutingProfile to retrieve the chat routing configuration.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

Instance ID.

ccc-test

Response elements

Element

Type

Description

Example

object

Code

string

Response code.

OK

HttpStatusCode

integer

HTTP status code.

200

Message

string

Response message.

RequestId

string

Request ID.

30C7D235-DDCF-4C7F-A462-5E2598252C2B

Data

object

Data.

RoutingType

string

Call distribution type.

  • Automatic distribution (Automatic).

  • Manual distribution (Manual).

Automatic

AgentConcurrencySettings

string

Agent session concurrent configuration.

  • AllowExceedingLimitWhenTransferring: Allow exceeding the limit when transferring. When transferring sessions to other agents, exceeding the recipient's limit is allowed, but the total cannot exceed 30.

  • AllowExceedingLimitWhenClaiming: Allow exceeding the limit when claiming. When an agent actively claims sessions from the queue, exceeding the limit is allowed, but the total cannot exceed 30.

  • ConcurrencyLimit: The number of network business sessions an agent can process simultaneously.

  • Enabled: Enable this configuration.

{ "AllowExceedingLimitWhenTransferring": false, "ConcurrencyLimit": 4, "AllowExceedingLimitWhenClaiming": true, "Enabled": true }

DistributionSettings

string

Agent session allocation configuration.

  • AgentRingTimeoutSeconds: Agent processing timeout limit.

  • MaxNumberOfConversationsAgentCanMiss: The maximum number of consecutive unanswered sessions an agent can miss.

  • PostAgentMissingConversionsAction: After an agent misses more than the set number of consecutive responses, the system sets the agent's status, such as Break, Invisible, or Nothing (remain unchanged).

  • Enabled: Enable.

{ "AgentRingTimeoutSeconds": 30, "Enabled": true, "MaxNumberOfConversationsAgentCanMiss": 5, "PostAgentMissingConversionsAction": "Nothing" }

ChatSettings

string

Session configuration.

  • IdleChatTimeoutSeconds: Automatic session end time. If no customer response is received within a specific period, the system ends the session. Unit: seconds.

{"IdleChatTimeoutSeconds":300}

Examples

Success response

JSON format

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "30C7D235-DDCF-4C7F-A462-5E2598252C2B",
  "Data": {
    "RoutingType": "Automatic",
    "AgentConcurrencySettings": "{\n    \"AllowExceedingLimitWhenTransferring\": false,\n    \"ConcurrencyLimit\": 4,\n    \"AllowExceedingLimitWhenClaiming\": true,\n    \"Enabled\": true\n}",
    "DistributionSettings": "{\n    \"AgentRingTimeoutSeconds\": 30,\n    \"Enabled\": true,\n    \"MaxNumberOfConversationsAgentCanMiss\": 5,\n    \"PostAgentMissingConversionsAction\": \"Nothing\"\n}",
    "ChatSettings": "{\"IdleChatTimeoutSeconds\":300}"
  }
}

Error codes

HTTP status code

Error code

Error message

Description

400 Parameter.Blank The parameter %s must not be null.
400 Parameter.Empty The parameter %s must not be null or empty.
400 Parameter.Null The parameter %s must not be null.
404 NotExists.InstanceId The specified instance %s does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.