设置联系方式
联系方式可作为触达对象用于通道触达,如 App 通知、短信、邮件、WhatsApp等。当用户的联系方式发生变更时,可使用本接口更新
设置联系方式必须基于 EUID 进行设置
调用地址
POST /v1/user/contact
调用验证
EngageLab REST API 采用 HTTP 基本认证 的验证方式:HTTP Header(头)里加 Authorization:
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
此代码块在浮窗中显示
上述 base64_auth_string 的生成算法为:base64(api_key:api_secret)
- Header 名称是 "Authorization",值是 base64 转换过的 "username:password" 对(中间有个冒号)。
- 在 MA API 的场景里,username 是 APIKey,password 是 APISecret。请在数据来源中添加 API 类型的数据源获得 APIKey 与 API Secret。
请求示例
请求头
> POST /v1/user/contact
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
> POST /v1/user/contact
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
此代码块在浮窗中显示
请求体
{
"euid":10362473,
"contacts":{
"mobile_phone": "18023456879",
"email": "12@gmail.com"
}
}
{
"euid":10362473,
"contacts":{
"mobile_phone": "18023456879",
"email": "12@gmail.com"
}
}
此代码块在浮窗中显示
请求参数
字段 | 类型 | 必填 | 描述 |
---|---|---|---|
euid | Long | 是 | 用户唯一 ID |
contacts | JSON | 是 | key 是联系方式名称,value 是联系方式的值,都为 string 数据类型。 |
返回参数
字段 | 类型 | 必填 | 描述 |
---|---|---|---|
code | Int | 是 | 接口调用是否成功,0 表示成功或者部分成功,其他值代表失败 |
message | String | 是 | 接口调用结果描述,对返回码的说明 |
全部成功
{
"code": 0,
"message": "success"
}
{
"code": 0,
"message": "success"
}
此代码块在浮窗中显示
全部失败
{
"code": 55014,
"message": "Contact exists"
}
{
"code": 55014,
"message": "Contact exists"
}
此代码块在浮窗中显示
错误码
错误码 | 描述 | 详细说明 |
---|---|---|
40050 | I接口鉴权失败 | 确认项目ID和项目密钥是否正确 |
40007 | EUID为空 | 请检查 EUID 的值 |
50031 | 项目 ID 非法 | 请检查 APIKey 和 APISecret 是否正确 |
50034 | 项目 ID 不存在 | 请检查 APIKey 和 APISecret 是否正确,检查项目是否已被删除 |
50074 | API 数据源不存在 | 请检查 APIKey 和 APISecret 是否正确,请检查 API 数据源是否已被删除 |
55004 | 业务参数不合法 | 请检查请求参数字段是否正确 |
55101 | 用户标识个数超限 | 确认用户标识的值的数量是否超过 100 个 |
55102 | 存在无效的用户属性名称 | 确认属性名称是否符合命名要求,是否为空/用到了保留字符/超过长度限制 |
55103 | 用户属性值不能为空 | 确认请求体中用户属性的值是否为空 |
55105 | 用户标识的 value 值不能超过 256 个字符 | 确认用户标识的值是否超过256个字符 |
55106 | 用户标识的名称不在支持范围内 | 确认用户标识的名称是否是 user_id、 anonymous_id、registration_id |
55107 | 用户标识的 value 值为空 | 确认请求体中用户标识的值是否为空 |
55108 | 无效的 EUID | 请检查 EUID 的值 |
-1 | 服务器内部错误 | 请联系 EngageLab 技术支持 |