设置联系方式 API
最近更新:2023-11-13
设置联系方式 API
在运营增长平台中,联系方式可作为触达对象用于通道触达,如APP通知、短信、邮件等
当用户的联系方式发生变更时,可使用本接口更新用户在「触达通道」-「联系标签」的「联系方式」
设置联系方式必须基于CUID进行设置,且该联系方式对应的key(联系标签)已经存在于运营增长平台的通道管理中心
请求方式
PUT
请求地址
PUT https://growth.jiguang.cn/smartop/api/v1/user/channel/batch
PUT https://growth.jiguang.cn/smartop/api/v1/user/channel/batch
此代码块在浮窗中显示
QPS限制
QPS≤100
请求头
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
此代码块在浮窗中显示
请求体参数
接口支持多个cuid用户批量设置,请求数据条数须≤100 条。
真实业务场景下,请不要携带注释,下方示例的注释仅为帮助开发者理解参数意义
[{
"cuid": 10362819, // 用户身份ID
"channels": [{
"id": 210, // 通道ID
"channelValues": {
"默认联系": "15088888888", // 联系标签: 联系方式
"自定义联系": "123@qq.com"
}
}, {
"id": 2210,
"channelValues": {
"默认联系": "15099999999",
"自定义联系1": "123@qq.com"
}
}]
}, {
"cuid": 103629,
"channels": [{
"id": 219,
"channelValues": {
"默认联系": "15088888888",
"自定义联系": "123@qq.com"
}
}]
}]
[{
"cuid": 10362819, // 用户身份ID
"channels": [{
"id": 210, // 通道ID
"channelValues": {
"默认联系": "15088888888", // 联系标签: 联系方式
"自定义联系": "123@qq.com"
}
}, {
"id": 2210,
"channelValues": {
"默认联系": "15099999999",
"自定义联系1": "123@qq.com"
}
}]
}, {
"cuid": 103629,
"channels": [{
"id": 219,
"channelValues": {
"默认联系": "15088888888",
"自定义联系": "123@qq.com"
}
}]
}]
此代码块在浮窗中显示
字段 | 类型 | 必填 | 描述 |
---|---|---|---|
cuid | Long | 是 | 运营增长平台用户唯一ID |
channels | Array | 是 | 通道信息列表 |
id | Long | 是 | 通道ID |
channelValues | JSON Object | 是 | 各类别通道信息键值对,key是联系标签名,value是联系方式 |
- 为指定「通道ID」下的「联系标签」设置用户的「联系方式」。
- 初始联系标签名称为「默认联系」,若要设置自定义的名称则需要先在平台界面上添加联系标签。
- 支持同时设置多个用户的多个「联系标签」的值。
- 设置「APP通知」的「联系标签」时,其值须为该用户的Registration ID。
- 设置「短信」的「联系标签」时,其值须为11位数字(手机号码格式)
响应参数
- N/A,HTTP 代码返回 200 表示接口响应成功。
字段 | 类型 | 必填 | 描述 |
---|---|---|---|
code | Int | 是 | 接口调用是否成功,0表示成功,其他值代表出错,其中4000代表有多个错误(需要在data中查看错误列表) |
msg | String | 是 | 接口调用结果描述,对错误码的文字说明 |
data | Array | 否 | 错误码列表 |
code | Int | 是 | 设置「联系标签」错误码 |
msg | String | 是 | 设置「联系标签」错误码的文字说明 |
成功响应
{
"code": 0,
"msg": "ok"
}
{
"code": 0,
"msg": "ok"
}
此代码块在浮窗中显示
失败响应
单个错误响应:
{
"code": 4107,
"msg": "通道信息保存异常![默认联系1] 联系标签不存在"
}
{
"code": 4107,
"msg": "通道信息保存异常![默认联系1] 联系标签不存在"
}
此代码块在浮窗中显示
多个错误响应:
{
"code": 4000,
"msg": "请求有多个错误,请在data中查看错误码列表",
"data": [
{
"code": 4107,
"msg": "通道信息保存异常![默认联系1] 联系标签不存在"
},
{
"code": 4107,
"msg": "通道信息保存异常![1234567] CUID不存在"
}
]
}
{
"code": 4000,
"msg": "请求有多个错误,请在data中查看错误码列表",
"data": [
{
"code": 4107,
"msg": "通道信息保存异常![默认联系1] 联系标签不存在"
},
{
"code": 4107,
"msg": "通道信息保存异常![1234567] CUID不存在"
}
]
}
此代码块在浮窗中显示
错误码
错误码 | 错误码说明 | 解决措施 |
---|---|---|
40011 | cuid数组数量超过限制 | 控制cuid数组数量在1-100之间 |
40002 | 业务参数不合法 | 根据msg提示处理 |
4000 | 请求有多个错误 | 在data中查看错误码列表 |
4107 | 通道信息保存异常,例如(CUID不存在;联系标签不存在;通道id不存在;jg_registration_id不合法;短信通道取值不合法) | 根据msg提示处理 |
文档内容是否对您有帮助?