Set Contact Information
Contact information can be used as the target for channel outreach, such as App notifications, SMS, emails, WhatsApp, etc. When a user's contact information changes, this interface can be used to update it.
Setting contact information must be done based on the EUID.
Invocation Address
POST /v1/user/contact
Invocation Verification
The EngageLab REST API uses the verification method of HTTP Basic Authentication: Add Authorization to the HTTP Header:
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
โค้ดนี้โชว์เป็นหน้าต่างลอย
The generation algorithm for the above base64_auth_string is: base64(api_key:api_secret)
- The header name is "Authorization", and the value is the base64-converted "username:password" pair (with a colon in the middle).
- In the scenario of the MA API, the username is the APIKey, and the password is the APISecret. Please add a data source of the API type in the data source to obtain the APIKey and API Secret.
Request Example
Request Header
> POST /v1/user/contact
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
> POST /v1/user/contact
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
โค้ดนี้โชว์เป็นหน้าต่างลอย
Request Body
{
"euid":10362473,
"contacts":{
"mobile_phone": "18023456879",
"email": "12@gmail.com"
}
}
{
"euid":10362473,
"contacts":{
"mobile_phone": "18023456879",
"email": "12@gmail.com"
}
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Request Parameters
Field | Type | Required | Description |
---|---|---|---|
euid | Long | Yes | The unique user ID |
contacts | JSON | Yes | The key is the name of the contact information, and the value is the value of the contact information, both of which are of the string data type. |
Return Parameters
Field | Type | Required | Description |
---|---|---|---|
code | Int | Yes | Whether the interface call is successful. 0 indicates success or partial success, and other values represent failure. |
message | String | Yes | The description of the interface call result, an explanation of the return code. |
All Successful
{
"code": 0,
"message": "success"
}
{
"code": 0,
"message": "success"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
All Failed
{
"code": 0,
"message": "success"
}
{
"code": 0,
"message": "success"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Error Code
Code | Description | Detailed Explanation |
---|---|---|
40050 | Interface authentication failed. | Confirm whether the project ID and project secret key are correct. |
40007 | EUID is empty. | Please check the value of EUID. |
50031 | Project ID is invalid. | Please check whether the APIKey and APISecret are correct. |
50034 | Project ID does not exist. | Please check whether the APIKey and APISecret are correct, and check whether the project has been deleted. |
50074 | API data source does not exist. | Please check whether the APIKey and APISecret are correct, and check whether the API data source has been deleted. |
55004 | Business parameters are invalid. | Please check whether the fields of the request parameters are correct. |
55101 | The number of user identifiers exceeds the limit. | Confirm whether the number of values of the user identification exceeds 100. |
55102 | There are invalid user attribute names. | Confirm whether the attribute name meets the naming requirements, and whether it is empty/uses reserved characters/exceeds the length limit. |
55103 | User attribute values cannot be empty. | Confirm whether the value of the user attribute in the request body is empty. |
55105 | The value of the user identifier cannot exceed 256 characters. | Confirm whether the value of the user identification exceeds 256 characters. |
55106 | The name of the user identifier is not within the supported range. | Confirm whether the name of the user identification is user_id, anonymous_id, or registration_id. |
55107 | The value of the user identifier is empty. | Confirm whether the value of the user identification in the request body is empty. |
55108 | Invalid EUID. | Please check the value of EUID. |
-1 | Internal server error. | Please contact EngageLab technical support. |