設置聯繫方式
聯繫方式可作為觸達對象用於通道觸達,如 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": 0,
"message": "success"
}
{
"code": 0,
"message": "success"
}
此代碼塊在浮窗中顯示
錯誤碼
錯誤碼 | 描述 | 詳細說明 |
---|---|---|
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 技術支持 |