创建用户信息
POST /apiv2/users.json
调用权限
agent
①可以通过email和phone两种属性来创建用户。当email和phone参数同时存在时,以email优先创建用户
②微信用户可以通过wechat_openid(微信用户的openid)和wechat_appid(微信公众号的id)两种属性来创建。
创建微信用户时这两个参数必须传递,缺失其一,都会创建失败,并返回错误信息。wechat_appid必须是逸创云客服后台绑定的公众号,wechat_appid的值可以通过 【逸创云客服后台>>设置>>微信客服>>原始号】 来获取
curl 示例
curl -v -u {email_address}:{password} https://{subdomain}.kf5.com/apiv2/users.json \ -H "Content-Type: application/json" -X POST -d '{"user": {"name": "water", "email": "liuming@qq.com", "phone": "18613200119", "wechat_openid": "waterank_5", "wechat_appid":"gh_2ed5c53q1800","assignee_id":"78986723"}}'
assignee_id:为受理客服ID
创建微信用户示例
POST https://{subdomain}.kf5.com/apiv2/users.json{ "user": { "name": "微信用户XXX", ...... "wechat_appid": 10031, "wechat_openid": "osQZ6s4ck6tYz1Y94KZHW-I4DNrY" }}
创建自定义 IM 用户示例
POST https://{subdomain}.kf5.com/apiv2/users.json{ "user": { "name": "自定义IM用户XXX", ...... "relation_source": "custom_im", "appid": 10042, "openid": "86dbda683124266a8232dde4696964001" }}
relation_source:固定值 custom_im
appid:自定义 IM 的 ID,可以在工单系统后台查看:设置>>客服接入渠道>>自定义IM来源
openid:在自定义 IM 接口中使用的 openid,是用户在客户自己系统或第三方系统中的用户 ID,可以是 integer 或 string 类型
创建自定义字段有值的 用户示例
POST https://{subdomain}.kf5.com/apiv2/users.json { "user": { "name": "自定义IM用户XXX", ...... "user_fields":[ { "name":"field_123", "value":"kf5-test" } ] } }
返回示例
Status: 201 Created Location: https://{subdomain}.kf5.com/apiv2/users/{id}.json{ "user": { "id": 66, "name": "water", ... }}