GetVisitorLoginDetails-阿里云帮助中心

Call GetVisitorLoginDetails to retrieve login, server address, and authentication information for network service visitors.

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	No	Instance ID.	ccc-test
VisitorId	string	Yes	Visitor ID.	fcd020fe-d8e4-40e5-8c77-1a272a174a7d
ChatDeviceId	string	Yes	Chat device ID.	4c51c9116c36537cb850dc1081d745df
Token	string	No	Channel token for network services.	9XYGTGWtq2wFi_Bpg7aUnIoYi_vG_rO3b*YtsxbHRHrYHlz1LDBLJAyZcLxieRQR4h_6AnWvTjJeNU5jgxzO***bHwej7WgWrmA

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.	19D09CCC-F298-4124-849A-AFA217819011
Params	array	Parameter information.
	string	Parameter list.	无
Data	object	Returned data.
ChatLoginToken	string	Chat session login token.	{"accessToken":"oauth_cloud_key:+4oJXUAFSWxGD2YuRW4V/oUN0/8qJGNc0I*******n1E3DOr3Q3lX00ZnTpyqRi8Y6hYoLYA7n2ZkWuv485hVtXeSgnIQkKxXPbMgwoLxWaK//lI5Dn/mb4YuDifigv+ZyFzc+07vxm9ZFu/NjA==","accessTokenExpiredTime":86400000,"refreshToken":"oauth_cloud_key:/U+8UueDmpeUszhXC+SWow4pNLZp2C*********U/377BNXF+Mjo1lFgDk6GtEjNNoJpapX2mHH8GcRke2+yKQs/w4gAN9xSMn543Ciung+93pXV6IpQGbEVlu"}
ChatUserId	string	Visitor's identity ID.	dac9c001****a15684ea91a81317
ChatDeviceId	string	Chat device ID.	4c51c9116c36537cb850dc1081d745df
ChatServerUrl	string	Chat session server address.	wss://wss.im.dingtalk.cn
ChatAppKey	string	Chat session application key.	955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0
ChatAppId	string	Chat session application ID.	7pjxxx

Examples

Success response

JSON format

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "19D09CCC-F298-4124-849A-AFA217819011",
  "Params": [
    "无"
  ],
  "Data": {
    "ChatLoginToken": "{\"accessToken\":\"oauth_cloud_key:+4oJXUAFSWxGD2YuRW4V/oUN0/8qJGNc0I*********n1E3DOr3Q3lX00ZnTpyqRi8Y6hYoLYA7n2ZkWuv485hVtXeSgnIQkKxXPbMgwoLxWaK//lI5Dn/mb4YuDifigv+ZyFzc+07vxm9ZFu/NjA==\",\"accessTokenExpiredTime\":86400000,\"refreshToken\":\"oauth_cloud_key:/U+8UueDmpeUszhXC+SWow4pNLZp2C***********U/377BNXF+Mjo1lFgDk6GtEjNNoJpapX2mHH8GcRke2+yKQs/w4gAN9xSMn543Ciung+93pXV6IpQGbEVlu\"}",
    "ChatUserId": "dac9c001****a15684ea91a81317",
    "ChatDeviceId": "4c51c9116c36537cb850dc1081d745df",
    "ChatServerUrl": "wss://wss.im.dingtalk.cn",
    "ChatAppKey": "955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0",
    "ChatAppId": "7pjxxx"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	NotExists.InstanceId	The specified instance %s does not exist.
404	NotExists.UserId	The user %s does not exist in instance %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.