連絡先情報を設定
連絡先情報は、App通知、SMS、電子メール、WhatsAppなどのチャネルプロモーションのターゲットとして使用できます。ユーザーの連絡先情報が変更された場合、このインターフェースを使用して更新できます。
連絡先情報の設定はEUIDに基づく必要があります。
呼び出しアドレス
POST /v1/user/contact
呼び出し認証
EngageLab REST APIはHTTP基本認証の認証方式を使用します:HTTPヘッダーにAuthorizationを追加します:
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
このコードブロックはフローティングウィンドウ内に表示されます
上記のbase64_auth_stringの生成アルゴリズムは:base64(api_key:api_secret)
- ヘッダー名は"Authorization"で、値はbase64変換後の"username:password"ペア(コロンで区切る)。
- MA APIシナリオでは、usernameはAPIKey、passwordはAPISecretです。データソースにAPIタイプのデータソースを追加してAPIKeyとAPISecretを取得してください。
リクエスト例
リクエストヘッダー
> 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 | はい | キーは連絡先情報の名称、値は連絡先情報の値で、いずれも文字列データ型です。 |
レスポンスパラメーター
フィールド | タイプ | 必須か | 説明 |
---|---|---|---|
code | Int | はい | インターフェース呼び出しが成功したかどうか。0は成功または部分的成功を示し、それ以外の値は失敗を示します。 |
message | String | はい | インターフェース呼び出し結果の説明、返却コードの説明。 |
全て成功
{
"code": 0,
"message": "success"
}
{
"code": 0,
"message": "success"
}
このコードブロックはフローティングウィンドウ内に表示されます
全て失敗
{
"code": 0,
"message": "success"
}
{
"code": 0,
"message": "success"
}
このコードブロックはフローティングウィンドウ内に表示されます
エラーコード
エラーコード | 説明 | 詳細説明 |
---|---|---|
40050 | インターフェース認証失敗。 | プロジェクトIDとプロジェクトキーが正しいか確認してください。 |
40007 | EUIDが空です。 | EUIDの値を確認してください。 |
50031 | プロジェクトIDが無効です。 | APIKeyとAPISecretが正しいか確認してください。 |
50034 | プロジェクトIDが存在しません。 | APIKeyとAPISecretが正しいか、プロジェクトが削除されていないか確認してください。 |
50074 | APIデータソースが存在しません。 | APIKeyとAPISecretが正しいか、APIデータソースが削除されていないか確認してください。 |
55004 | ビジネスパラメーターが無効です。 | リクエストパラメーターのフィールドが正しいか確認してください。 |
55101 | ユーザー識別子の数が制限を超えています。 | ユーザー識別子の値の数が100を超えていないか確認してください。 |
55102 | 無効なユーザー属性名が存在します。 | 属性名が命名要件を満たしているか、空でないか、予約文字を使用していないか、長さ制限を超えていないか確認してください。 |
55103 | ユーザー属性値が空です。 | リクエストボディのユーザー属性値が空でないか確認してください。 |
55105 | ユーザー識別子の値が256文字を超えています。 | ユーザー識別子の値が256文字を超えていないか確認してください。 |
55106 | ユーザー識別子の名前がサポート範囲外です。 | ユーザー識別子の名前がuser_id、anonymous_id、またはregistration_idであるか確認してください。 |
55107 | ユーザー識別子の値が空です。 | リクエストボディのユーザー識別子の値が空でないか確認してください。 |
55108 | EUIDが無効です。 | EUIDの値を確認してください。 |
-1 | 内部サーバーエラー。 | EngageLabの技術サポートに連絡してください。 |