文档
测试

发起1对1聊天

POST
http://foxconn.gateway.api.liyueyun.com/api/chatextensions/startChat

接口描述

发起1对1聊天,可以添加业务系统链接

header

参数名
类型
描述
必填
Authorization
string
示例:Bearer a447bdDAUeKORvmt
必填

body

参数名
类型
描述
必填
from
object
发起者信息(必填)
必填
empno
string
发起者工号(必填)
必填
name
string
发起者姓名(必填)
必填
email
string
发起者邮箱(必填)
必填
to
object
接收者信息(必填)
必填
empno
string
接收者工号(必填)
必填
name
string
接收者姓名(必填)
必填
email
string
接收者邮箱(必填)
必填
title
string
附加信息标题
必填
list
array
附加信息数据列表
必填
label
string
示例:单号
必填
text
string
示例:123456
必填
link
string
附加信息点击可打开的链接
必填
iconSrc
附加信息图标
必填

response

参数名
类型
描述
必填
url
string
聊天界面链接
必填

说明 / 示例

#### 错误列表 |httpCode|error|message| |-|-|-| |401|AccessTokenNoExist|必须有 accessToken| |401|AccessTokenIsInvalid|无效的 accessToken| |401|AccessTokenHasExpired|accessToken 已过期| |403|SecretIsInvalid|无效的 secret| |403|SecretHasDisabled|secret 已被禁用| |403|SecretError|secret 状态异常| |403|LimitExceeded|已超出用量限制| |403|INVALID_PARAMETER|参数不匹配| |500|App_Module_Not_Formal|此服务模块还未申请正式| #### 示例代码 ##### C#访问示例代码: ~~~CSharp var client = new RestClient("http://foxconn.gateway.api.liyueyun.com/api/chatextensions/startChat"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\"from\":{\"empno\":\"发起者工号\",\"name\":\"发起者姓名\",\"email\":\"发起者邮箱\"},\"to\":{\"empno\":\"接收者工号\",\"name\":\"接收者姓名\",\"email\":\"接收者邮箱\"},\"title\":\"附加信息标题\",\"list\":[{\"label\":\"单号\",\"text\":\"123456\"}],\"link\":\"http://xxx.com\",\"iconSrc\":\"http://xxx.com/xx.png\"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); ~~~ # ##### Java访问示例代码: ~~~ java OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"from\":{\"empno\":\"发起者工号\",\"name\":\"发起者姓名\",\"email\":\"发起者邮箱\"},\"to\":{\"empno\":\"接收者工号\",\"name\":\"接收者姓名\",\"email\":\"接收者邮箱\"},\"title\":\"附加信息标题\",\"list\":[{\"label\":\"单号\",\"text\":\"123456\"}],\"link\":\"http://xxx.com\",\"iconSrc\":\"http://xxx.com/xx.png\"}"); Request request = new Request.Builder() .url("http://foxconn.gateway.api.liyueyun.com/api/chatextensions/startChat") .method("POST", body) .addHeader("Content-Type", "application/json") .build(); Response response = client.newCall(request).execute(); ~~~ # #### Nodejs访问示例代码 ~~~javascript var unirest = require('unirest'); var req = unirest('POST', 'http://foxconn.gateway.api.liyueyun.com/api/chatextensions/startChat') .headers({ 'Content-Type': 'application/json' }) .send(JSON.stringify({"from":{"empno":"发起者工号","name":"发起者姓名","email":"发起者邮箱"},"to":{"empno":"接收者工号","name":"接收者姓名","email":"接收者邮箱"},"title":"附加信息标题","list":[{"label":"单号","text":"123456"}],"link":"http://xxx.com","iconSrc":"http://xxx.com/xx.png"})) .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); ~~~