ClaimChat-阿里云帮助中心

You can call ClaimChat to claim the chat for a specified Job ID in a specified instance.

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
SkillGroupId	string	Yes	Filter by skill group ID.	skillgroup@ccc-test
JobId	string	Yes	The ID of the call.	chat-65382141036853491

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.	BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E
Params	array	List of response parameters.
	string	Response parameter.	无
Data	object	Data.
ContextId	integer	System auto-increment ID. Customers do not need to be concerned.	123456789
UserContext	object	Agent context.
Heartbeat	integer	Time of the agent's last heartbeat, in Unix timestamp format, in milliseconds.	1609136956378
Extension	string	Agent extension number.	8032****
WorkMode	string	Work mode. Not applicable for chat scenarios. Enumerated values: ON_SITE: On-site mode. OFF_SITE: Off-site mode. OFFICE_PHONE: Office phone mode.	ON_SITE
DeviceId	string	Device ID.	CCC-169.254.165.2-browser125.0.0-bs48b41903450e6c8
UserId	string	Agent ID.	userId@ccc-test
Reserved	integer	Time when the agent was last reserved, in Unix timestamp format, in milliseconds.	false
BreakCode	string	Break status code.	Warm-up
InstanceId	string	Instance ID.	ccc-test
OutboundScenario	boolean	Outbound call scenario only. Not applicable for chat services.	false
DeviceState	string	Device state.	ONLINE
Mobile	string	Agent's personal phone number. Not applicable for chat scenarios.	18******102
JobId	string	Job ID.	chat-65382141036853491
UserState	string	Agent state. Enumerated values: READY: Idle. WORKING: Post-call processing. BREAK: Break. OFFLINE: Offline. TALKING: Chatting. RINGING: Incoming chat.	TALKING
SignedSkillGroupIdList	array	List of skill group IDs the agent is signed into.
	string	Skill group ID.	skg-default@ccc-test
ChatContexts	array<object>	Session context.
	object
InstanceId	string	Instance ID.	ccc-test
JobId	string	Job ID.	chat-65382141036853491
ChatType	string	Session type.	INBOUND
CallVariables	string	Call variables.	无
AccessChannelId	string	Network service channel ID.	226**-cbb6-**-8fea-1e71baf7bfa7
AccessChannelType	string	Network service channel type.	Web
AccessChannelName	string	Network service channel name.	测试渠道
BeingAssigned	boolean	Whether the session has been assigned to an agent.	true

Examples

Success response

JSON format

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E",
  "Params": [
    "无"
  ],
  "Data": {
    "ContextId": 123456789,
    "UserContext": {
      "Heartbeat": 1609136956378,
      "Extension": "8032****\n",
      "WorkMode": "ON_SITE",
      "DeviceId": "CCC-169.254.165.2-browser125.0.0-bs48b41903450e6c8",
      "UserId": "userId@ccc-test",
      "Reserved": 0,
      "BreakCode": "Warm-up",
      "InstanceId": "ccc-test",
      "OutboundScenario": false,
      "DeviceState": "ONLINE",
      "Mobile": "18******102",
      "JobId": "chat-65382141036853491\n",
      "UserState": "TALKING",
      "SignedSkillGroupIdList": [
        "skg-default@ccc-test"
      ]
    },
    "ChatContexts": [
      {
        "InstanceId": "ccc-test",
        "JobId": "chat-65382141036853491\n",
        "ChatType": "INBOUND",
        "CallVariables": "无",
        "AccessChannelId": "226****-cbb6-****-8fea-1e71baf7bfa7",
        "AccessChannelType": "Web",
        "AccessChannelName": "测试渠道",
        "BeingAssigned": true
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	Parameter.Blank	The parameter %s must not be null.
500	InternalService.CTI	An internal CTI service error occurred.
404	NotExists.ChannelId	The specified channel %s does not exist in call %s.
404	NotExists.InstanceId	The specified instance %s does not exist.
404	NotExists.JobId	The call %s does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.