设置联系方式
最新更新:2025-03-18
联系方式可作为触达对象用于通道触达,如 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 | 接口鉴权失败 | 确认密钥是否正确 |
55014 | 联系方式已被设置 | 请检查是否设置唯一性 |