顧客リストの取得
このAPIは、複数の顧客情報を一度に取得するために使用されます。 このAPIは最大10,000件のデータしか取得できません。より多くのデータを取得する必要がある場合は、顧客エクスポートAPIをご利用ください。
リクエストメソッド
GET /customers
リクエストパラメータ（Query String）
| パラメータ名 | タイプ | 必須 | 説明 | 制限 |
|---|---|---|---|---|
| filter_id | 整数型 | いいえ | 顧客フィルターID | |
| query | 文字列型 | いいえ | 顧客検索時のキーワード | |
| page | 整数型 | いいえ | ページ番号（1から開始、デフォルトは1） | |
| page_size | 整数型 | いいえ | 1ページあたりの件数（デフォルト20、最大100） |
レスポンスデータ
| 属性名 | タイプ | 説明 |
|---|---|---|
| code | 整数型 | 実行結果コード（1000は成功を表します） |
| meta | オブジェクト | ページネーション情報。詳細は共通データを参照してください。 |
| customers | 配列 | 顧客リスト。各顧客の説明は顧客データを参照してください。 |
| 配列 | 微信（WeChat）チャネル情報。詳細は以下を参照してください。 | |
| 配列 | 微博（Weibo）チャネル情報。詳細は以下を参照してください。 |
| 属性名 | タイプ | 説明 |
|---|---|---|
| id | 文字列型 | 顧客が所属する会社の最初の微信（WeChat）チャネルのapp_id |
| name | 文字列型 | 顧客が所属する会社の最初の微信（WeChat）チャネルの名称 |
| 属性名 | タイプ | 説明 |
|---|---|---|
| id | 文字列型 | 顧客が所属する会社の最初の微博（Weibo）チャネルのapp_id |
| name | 文字列型 | 顧客が所属する会社の最初の微博（Weibo）チャネルの名称 |
例
curl https://demo.udesk.cn/open_api_v1/customers?page=1&page_size=10&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
レスポンス
{
"code": 1000,
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1
},
"wechat": [
{
"id": "wxee100100100abc",
"name": "顧客1"
},
{
"id": "wxee100100100qwe",
"name": "顧客2"
}
],
"weibo": [
{
"id": "wb1001001001",
"name": "顧客1"
},
{
"id": "wb1001001002",
"name": "顧客2"
}
],
"customers": [
{
"id": 1,
"nick_name": "テストユーザー",
"level": "normal",
"description": null,
"owner_id": 1,
"owner_group_id": 1,
"custom_fields": {
"SelectField_1": ["0"],
"SelectField_2": ["0"]
},
"open_api_token": null,
"organization_id": null,
"is_blocked": false,
"web_token": "dcc79435-e9e2-436a-9cdf-c9f13f728923",
"sdk_token": "b0bf5c37-ebdd-4539-a961-7941aca02e4c",
"tags": [],
"rich_tags": [
{
"id": 1,
"name": "リッチテキストタグ1",
"color": "#70BE72",
"company_id": 1
}
],
"first_contact_at": null,
"last_contact_at": null,
"first_contact_at_via_phone": null,
"last_contact_at_via_phone": null,
"first_contact_at_via_im": null,
"last_contact_at_via_im": null,
"email": "customer@sample.com",
"other_emails": [],
"cellphones": [
{
"id": 1,
"content": "13000000001"
}
],
"platform": "手動入力",
"source_channel": "手動作成",
"weixins": [
{
"appid": "wxf54489a1azz51885",
"openid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk",
"unionid": ""
}
],
"weixin_minis": [
{
"appid": "wxc7279f8eefd70a4a",
"openid": "oa3cT0mano9wVhIpkp3drqy9yDuw",
"unionid": ""
}
],
"weixin_works": [
{
"agentid": "1009117",
"corpid": "wxc727955fe6025ed4",
"userid": "LS004308",
"open_userid": "o0Nng1Sdt5EFl8ZQ8qKAIpOuV9DI"
}
]
}
]
}
顧客詳細情報の取得
このインターフェースは、指定された条件に合致する顧客情報を取得するために使用されます。
リクエストメソッド
GET /customers/get_customer
リクエストパラメータ（Query String）
| パラメータ名 | タイプ | 必須 | 説明 | 制限事項 |
|---|---|---|---|---|
| type | 文字列 | はい | 条件タイプ（詳細は以下） | |
| content | 文字列 | はい | 条件内容 |
条件タイプ
| 値 | 対応するcontentの意味 |
|---|---|
| id | 顧客ID |
| 顧客メールアドレス | |
| cellphone | 顧客電話番号 |
| token | 顧客の外部一意識別子 |
| weixin_open_id | 顧客のWeChat OpenID |
| weixin_mini_openid | 顧客のWeChatミニアプリOpenID |
| weixin_work_identifier | 顧客の企業WeChatの一意識別子（例：cropid:wxc727955fe6025ed4,agentid:1009117,userid:LS004308） |
| weibo_id | 顧客のWeibo OpenID |
| sdk_token | 顧客のSDK識別子 |
| web_token | 顧客のWeb識別子 |
| ### 返却データ |
| 属性名 | タイプ | 説明 |
|---|---|---|
| code | 整数型 | 実行結果コード、1000は成功を表す |
| customer | オブジェクト | 顧客情報、顧客データを参照 |
例
curl https://demo.udesk.cn/open_api_v1/customers/get_customer?type=email&content=customer@sample.com&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
返却
{
"code": 1000,
"customer": {
"id": 1,
"nick_name": "テストユーザー",
"level": "normal",
"description": null,
"owner_id": 1,
"owner_group_id": 1,
"custom_fields": {
"SelectField_1": ["0"],
"SelectField_2": ["0"]
},
"open_api_token": null,
"organization_id": null,
"is_blocked": false,
"web_token": "dcc79435-e9e2-436a-9cdf-c9f13f728923",
"sdk_token": "b0bf5c37-ebdd-4539-a961-7941aca02e4c",
"tags": [],
"rich_tags": [
{
"id": 1,
"name": "リッチテキストタグ1",
"color": "#70BE72",
"company_id": 1
}
],
"first_contact_at": null,
"last_contact_at": null,
"first_contact_at_via_phone": null,
"last_contact_at_via_phone": null,
"first_contact_at_via_im": null,
"last_contact_at_via_im": null,
"email": "customer@sample.com",
"other_emails": [],
"cellphones": [
{
"id": 1,
"content": "13000000001"
}
],
"platform": "手動入力",
"source_channel": "手動作成",
"weixins": [
{
"appid": "wxf54489a1azz51885",
"openid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk",
"unionid": ""
}
],
"weixin_minis": [
{
"appid": "wxc7279f8eefd70a4a",
"openid": "oa3cT0mano9wVhIpkp3drqy9yDuw",
"unionid": ""
}
],
"weixin_works": [
{
"agentid": "1009117",
"corpid": "wxc727955fe6025ed4",
"userid": "LS004308",
"open_userid": "o0Nng1Sdt5EFl8ZQ8qKAIpOuV9DI"
}
],
"weixin_kfs": [
{
"external_userid": "wmtmN_BgAAj3Sj7j4hv9tD29NoiCZt9A",
"open_kfid": "wktmN_BgAAuVqNn__Ls5I8dClfOBbAvw",
"unionid": "o_7Qg6ROh71walfIHr7xtXr-VWDo"
}
]
}
}
顧客の作成
このAPIは顧客を作成するために使用されます。
リクエストメソッド
POST /customers
リクエストパラメータ（Request Body）
| パラメータ名 | タイプ | 必須 | 説明 | 制限 |
|---|---|---|---|---|
| customer | オブジェクト | はい | 顧客情報。詳細は以下を参照してください。 | |
| other_emails | 配列 | いいえ | その他のメールアドレスリスト。詳細は例を参照してください。 | |
| tags | 文字列 | いいえ | タグリスト。複数のタグはカンマで区切ります。 |
customer
| パラメータ名 | タイプ | 必須 | 説明 | 制限 |
|---|---|---|---|---|
| 文字列 | いいえ | メインのメールアドレス | 最大255文字 | |
| open_api_token | 文字列 | いいえ | 外部での一意の識別子 | 最大255文字 |
| nick_name | 文字列 | はい | 氏名 | 最大255文字 |
| organization_id | 整数 | いいえ | 顧客企業ID | |
| description | 文字列 | いいえ | 説明 | 最大255文字 |
| owner_id | 整数 | いいえ | 担当カスタマーサポートID | |
| owner_group_id | 整数 | いいえ | 担当カスタマーサポートグループID | |
| level | 文字列 | いいえ | レベル。デフォルトは'normal'。値については顧客データを参照してください。 | |
| is_blocked | ブール値 | いいえ | ブラックリストに追加するかどうか。デフォルトはfalse。 | 取り得る値はfalse、true |
| cellphones | 配列 | いいえ | 電話番号リスト。詳細は以下を参照してください。 | |
| weixins | 配列 | いいえ | WeChatリスト。詳細は以下を参照してください。 | |
| weixin_minis | 配列 | いいえ | WeChatミニプログラムリスト。詳細は以下を参照してください。 | |
| weixin_works | 配列 | いいえ | 企業WeChatリスト。詳細は以下を参照してください。 | |
| custom_fields | オブジェクト | いいえ | カスタムフィールド | "フィールドタイプ名"_"フィールド一意ID" 詳細 |
| web_token | 文字列 | いいえ | 顧客のWeb識別子 | 最大255文字 |
注意:
- カスタマーサポートID（owner_id）とカスタマーサポートグループID（owner_group_id）は関連しています。パラメータowner_idを使用する場合は、それに一致するowner_group_idを追加する必要があります。
web_token
- 英数字、@記号、ピリオド、ハイフン、アンダースコアのみサポートします。他の特殊文字は使用禁止です。メールアドレスまたは電話番号の使用を推奨します。
- ユーザーのweb_tokenを変更する場合、IMユーザー識別を使用する際、web_tokenもそれに応じて変更する必要があります。そうしないと、元のユーザーを識別できなくなります。
cellphones
各要素は配列です：[电话id, 电话文本]
電話番号を追加する場合、电话id は null です。詳細は例を参照してください。
weixins
各要素はオブジェクトで、以下の属性を含みます：
| パラメータ名 | タイプ | 必須 | 説明 | 制限 |
|---|---|---|---|---|
| action | 文字列 | はい | 実行アクション | 選択可能な値: "new": 追加, "delete": 削除 |
| appid | 文字列 | はい | 微信アプリケーションID | |
| openid | 文字列 | はい | 顧客の微信openid | |
| unionid | 文字列 | いいえ | 顧客の微信unionid |
注意：
- appid + openid は一意です。既に存在する場合はエラーになります。
- appid、openid が空のエントリは無視されます。actionの値が不正なエントリも無視されます。
- "delete" 操作は顧客情報更新時にのみ使用可能です。新規顧客作成時に現れた場合は無視されます。
- 顧客情報更新時、"delete" 操作が優先的に実行され、その後 "new" 操作が実行されます。
- 微信は事前に対応するカスタマーサポートシステムにバインドされている必要があります。操作場所：カスタマーサポートシステム -> 管理センター -> チャネル管理 -> 微信
weixin_minis
各要素はオブジェクトで、以下の属性を含みます：
| パラメータ名 | タイプ | 必須 | 説明 | 制限 |
|---|---|---|---|---|
| action | 文字列 | はい | 実行アクション | 選択可能な値: "new": 追加, "delete": 削除 |
| appid | 文字列 | はい | 微信ミニアプリID | |
| openid | 文字列 | はい | 顧客の微信ミニアプリopenid | |
| unionid | 文字列 | いいえ | 顧客の微信ミニアプリunionid |
注意：
- appid + openid は一意です。既に存在する場合はエラーになります。
- appid、openid が空のエントリは無視されます。actionの値が不正なエントリも無視されます。
- "delete" 操作は顧客情報更新時にのみ使用可能です。新規顧客作成時に現れた場合は無視されます。
- 顧客情報更新時、"delete" 操作が優先的に実行され、その後 "new" 操作が実行されます。
- 微信ミニアプリは事前に対応するカスタマーサポートシステムにバインドされている必要があります。操作場所：カスタマーサポートシステム -> 管理センター -> チャネル管理 -> ミニアプリ
weixin_works
各要素はオブジェクトであり、以下の属性を含みます:
| パラメータ名 | タイプ | 必須 | 説明 | 制限 |
|---|---|---|---|---|
| action | 文字列 | はい | 実行アクション | 選択可能な値: "new": 新規追加, "delete": 削除 |
| agentid | 文字列 | はい | 企業WeChatアプリケーションID | |
| userid | 文字列 | はい | 企業WeChat内のユーザーID | |
| corpid | 文字列 | はい | 企業WeChat内の企業ID | |
| open_userid | 文字列 | いいえ | 企業WeChatがサードパーティに提供する識別用ユーザーID |
注意: - 企業WeChatは事前に対応するカスタマーサービスシステムにバインドされている必要があります。操作場所: カスタマーサービスシステム -> 管理センター -> チャネル管理 -> 企業WeChat
weixin_kfs
各要素はオブジェクトであり、以下の属性を含みます:
| パラメータ名 | タイプ | 必須 | 説明 | 制限 |
|---|---|---|---|---|
| external_userid | 文字列 | いいえ | WeChatカスタマーサービスのexternal_userid | |
| open_kfid | 文字列 | いいえ | WeChatカスタマーサービスのopen_kfid | |
| unionid | 文字列 | いいえ | WeChatカスタマーサービスのunionid |
各要素はオブジェクトであり、以下の属性を含みます:
| パラメータ名 | タイプ | 必須 | 説明 | 制限 |
|---|---|---|---|---|
| action | 文字列 | はい | 実行アクション | 選択可能な値: "new": 新規追加, "delete": 削除 |
| agentid | 文字列 | はい | 企業WeChatアプリケーションID | |
| userid | 文字列 | はい | 企業WeChat内のユーザーID | |
| corpid | 文字列 | はい | 企業WeChat内の企業ID | |
| open_userid | 文字列 | いいえ | 企業WeChatがサードパーティに提供する識別用ユーザーID |
注意:
- corpid + agentid + userid は一意であり、既に存在する場合はエラーが発生します；
- corpid, agentid, userid が空のエントリは無視され、action の値が不正なエントリも無視されます；
- "delete" 操作は顧客更新時にのみ使用可能で、新規顧客作成時に出現した場合は無視されます；
- 顧客更新時は、まず "delete" 操作が実行され、その後 "new" 操作が実行されます。
返却データ
顧客詳細取得インターフェースと同じです。
例
curl https://demo.udesk.cn/open_api_v1/customers?email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
\
-X POST \
-H 'content-type: application/json' \
-d '
{
"customer": {
"email": "customer2@sample.com",
"nick_name": "テスト顧客2",
"owner_id": 1,
"owner_group_id": 1,
"level": "vip",
"is_blocked": false,
"cellphones": [
[null, "13100000002"],
[null, "13200000002"]
],
"custom_fields": {
"TextField_1": "通常テキスト内容",
"TextField_2": "複数行テキスト内容1\r\n複数行テキスト内容2",
"TextField_3": "2016-08-11",
"TextField_4": "14:44:36",
"TextField_5": "2017-05-03 14:44",
"TextField_6": "https://www.sample.com",
"TextField_7": "13",
"TextField_8": "13.33",
"SelectField_1": ["0"],
"SelectField_2": ["0"],
"SelectField_3": ["0","3"]
},
"weixins": [
{
"action": "new",
"appid": "wxf54489a1azz51885",
"openid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk",
"unionid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk"
}
],
"weixin_minis": [
{
"action": "new",
"appid": "wxc7279f8eefd70a4a",
"openid": "oa3cT0mano9wVhIpkp3drqy9yDuw",
"unionid": "sadgsathGdfsgBfhkfhgddfxzfAs"
}
],
"weixin_works": [
{
"action": "new",
"agentid": "1009117",
"corpid": "wxc727955fe6025ed4",
"userid": "LS004308",
"open_userid": "o0Nng1Sdt5EFl8ZQ8qKAIpOuV9DI"
}
]
},
"other_emails": [
[null, "customer2@sina.com"],
[null, "customer2@qq.com"]
],
"tags": "タグ1,タグ2"
}'
返却
{
"code": 1000,
"customer": {
"id": 1,
"nick_name": "テストユーザー",
"level": "normal",
"description": null,
"owner_id": 1,
"owner_group_id": 1,
"custom_fields": {
"TextField_1": "通常テキスト内容",
"TextField_2": "複数行テキスト内容1\r\n複数行テキスト内容2",
"TextField_3": "2016-08-11",
"TextField_4": "14:44:36",
"TextField_5": "2017-05-03 14:44",
"TextField_6": "https://www.sample.com",
"TextField_7": "13",
"TextField_8": "13.33",
"SelectField_1": ["0"],
"SelectField_2": ["0"],
"SelectField_3": ["0","3"]
},
"open_api_token": null,
"organization_id": null,
"is_blocked": false,
"tags": [
{
"id": 1,
"name": "タグ1",
"company_id": 1
},
{
"id": 1,
"name": "タグ2",
"company_id": 1
}
],
"rich_tags": [
{
"id": 1,
"name": "リッチテキストタグ1",
"color": "#70BE72",
"company_id": 1
},
{
"id": 2,
"name": "リッチテキストタグ2",
"color": "#70BE73",
"company_id": 1
}
],
"email": "customer@sample.com",
"other_emails": [
[3,"customer2@sina.com"],
[4,"customer2@qq.com"]
],
"cellphones": [
{
"id": 3,
"content": "13100000002"
},
{
"id": 4,
"content": "13200000002"
}
],
"platform": "手動入力",
"source_channel": "手動作成",
"weixins": [
{
"appid": "wxf54489a1azz51885",
"openid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk",
"unionid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk"
}
],
"weixin_minis": [
{
"appid": "wxc7279f8eefd70a4a",
"openid": "asdgasda0mano9hIpkp3drqy9yDuw",
"unionid": "sdagkjalkiairojhjnchfakhajKJa"
}
],
"weixin_works": [
{
"agentid": "1009117",
"corpid": "wxc727955fe6025ed4",
"userid": "LS004308",
"open_userid": "o0Nng1Sdt5EFl8ZQ8qKAIpOuV9DI"
}
]
}
}
顧客情報の更新
このAPIは顧客情報を変更するために使用されます。
リクエストメソッド
PUT /customers/update_customer
リクエストパラメータ（クエリストリング）
| パラメータ名 | 必須 | 説明 |
|---|---|---|
| type | はい | 条件タイプ |
| content | はい | 条件内容 |
詳細は顧客詳細情報取得APIを参照してください。
リクエストパラメータ（リクエストボディ）
顧客作成APIと同じです。
レスポンスデータ
顧客詳細情報取得APIと同じです。
例
curl https://demo.udesk.cn/open_api_v1/customers/update_customer?type=email&content=customer@sample.com&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X PUT \
-H 'content-type: application/json' \
-d '
{
"customer": {
"level": "normal",
"custom_fields": {
"TextField_1": "通常テキスト内容",
"TextField_2": "複数行テキスト内容1\r\n複数行テキスト内容2",
"TextField_3": "2016-08-11",
"TextField_4": "14:44:36",
"TextField_5": "2017-05-03 14:44",
"TextField_6": "https://www.sample.com",
"TextField_7": "13",
"TextField_8": "13.33",
"SelectField_1": ["0"],
"SelectField_2": ["0"],
"SelectField_3": ["0","3"]
},
"web_token": "dcc79435-e9e2-436a-9cdf-c9f13f728923",
"sdk_token": "b0bf5c37-ebdd-4539-a961-7941aca02e4c",
"weixins": [
{
"action": "new",
"appid": "wxf54489a1azz51885",
"openid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk",
"unionid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk"
},
{
"action": "delete",
"appid": "wxf54489a1azz51885",
"openid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk"
}
],
"weixin_minis": [
{
"action": "new",
"appid": "wxc7279f8eefd70a4a",
"openid": "oa3cT0mano9wVhIpkp3drqy9yDuw",
"unionid": "sadgsathGdfsgBfhkfhgddfxzfAs"
},
{
"action": "delete",
"appid": "wxc7279f8eefd70a4a",
"openid": "asdgasda0mano9hIpkp3drqy9yDuw"
}
],
"weixin_works": [
{
"action": "new",
"agentid": "1009117",
"corpid": "wxc727955fe6025ed4",
"userid": "LS004308",
"open_userid": "o0Nng1Sdt5EFl8ZQ8qKAIpOuV9DI"
},
{
"action": "delete",
"agentid": "1009118",
"corpid": "wxc727955fe6025ed5",
"userid": "LS004309",
"open_userid": "o0Nng1Sdt5EFl8ZQ8qKAIpOuV9DD"
}
]
},
"other_emails": [
[3, "customer2@sina1.com"]
]
}'
レスポンス
{
"code": 1000,
"customer": {
"id": 1,
"nick_name": "テストユーザー",
"level": "normal",
"description": null,
"owner_id": 1,
"owner_group_id": 1,
"first_contact_at": null,
"last_contact_at": null,
"first_contact_at_via_phone": null,
"last_contact_at_via_phone": null,
"first_contact_at_via_im": null,
"last_contact_at_via_im": null,
"custom_fields": {
"TextField_1": "通常テキスト内容",
"TextField_2": "複数行テキスト内容1\r\n複数行テキスト内容2",
"TextField_3": "2016-08-11",
"TextField_4": "14:44:36",
"TextField_5": "2017-05-03 14:44",
"TextField_6": "https://www.sample.com",
"TextField_7": "13",
"TextField_8": "13.33",
"SelectField_1": ["0"],
"SelectField_2": ["0"],
"SelectField_3": ["0","3"]
},
"open_api_token": null,
"organization_id": null,
"is_blocked": false,
"web_token": "dcc79435-e9e2-436a-9cdf-c9f13f728923",
"sdk_token": "b0bf5c37-ebdd-4539-a961-7941aca02e4c",
"tags": [
{
"id": 1,
"name": "タグ1",
"company_id": 1
},
{
"id": 1,
"name": "タグ2",
"company_id": 1
}
],
"rich_tags": [
{
"id": 1,
"name": "リッチテキストタグ1",
"color": "#70BE72",
"company_id": 1
},
{
"id": 2,
"name": "リッチテキストタグ2",
"color": "#70BE73",
"company_id": 1
}
],
"email": "customer@sample.com",
"other_emails": [
[3,"customer2@sina1.com"]
],
"cellphones": [
{
"id": 3,
"content": "13100000002"
},
{
"id": 4,
"content": "13200000002"
}
],
"platform": "手動入力",
"source_channel": "手動作成",
"weixins": [
{
"appid": "wxf54489a1azz51885",
"openid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk",
"unionid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk"
}
],
"weixin_minis": [
{
"appid": "wxc7279f8eefd70a4a",
"openid": "oa3cT0mano9wVhIpkp3drqy9yDuw"
}
],
"weixin_works": [
{
"agentid": "1009117",
"corpid": "wxc727955fe6025ed4",
"userid": "LS004308",
"open_userid": "o0Nng1Sdt5EFl8ZQ8qKAIpOuV9DI"
}
]
}
}
顧客削除
このAPIは顧客情報を削除するために使用されます。
リクエストメソッド
DELETE /customers/destroy_customer
リクエストパラメータ（Query String）
| パラメータ名 | 必須 | 説明 |
|---|---|---|
| type | はい | 条件タイプ |
| content | はい | 条件内容 |
詳細は顧客詳細情報取得APIを参照してください。
レスポンスデータ
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| code | 整数 | 実行結果コード、1000は成功を表す |
| customer_id | 整数 | 削除された顧客ID |
例
curl https://demo.udesk.cn/open_api_v1/customers/destroy_customer?type=id&content=1&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 -X DELETE
レスポンス
{
"code": 1000,
"customer_id": 1
}
顧客履歴リスト取得
このAPIは指定された条件の顧客の履歴情報を取得するために使用されます。
リクエストメソッド
GET /customers/feeds
リクエストパラメータ（Query String）
| プロパティ名 | 必須 | 説明 |
|---|---|---|
| type | はい | 条件タイプ |
| content | はい | 条件内容 |
| page | いいえ | ページ番号、1から開始、デフォルトは1 |
| page_size | いいえ | 1ページあたりの件数、デフォルト20、最大100 |
詳細は顧客詳細情報取得APIを参照してください。
レスポンスデータ
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| code | 整数 | 実行結果コード、1000は成功を表す |
| feeds | 配列 | 顧客履歴リスト、詳細は以下を参照 |
| meta | オブジェクト | ページネーション情報、詳細は共通データを参照 |
feeds要素
feedsの要素は5つのタイプに分けられます。すべてのタイプの要素は、以下のプロパティを含みます：
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| feed_type | 文字列 | タイプ |
その取り得る値は以下の通りです：
| 値 | 意味 |
|---|---|
| Ticket | チケット |
| CallLog | 通話記録 |
| ImSubSession | 会話記録 |
| CustomerFollowUp | フォローアップ記録 |
| Alternation | 変更記録 |
また、タイプごとに固有のプロパティを含みます：
Ticket
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| id | 整数 | チケットID |
| subject | 文字列 | タイトル |
| content | 文字列 | 内容 |
| user_id | 整数 | 顧客ID |
| user_group_id | 整数 | 担当カスタマーサポートグループID |
| status_zh_name | 文字列 | チケット状態の中国語名 |
| created_at | 日時 | チケット作成時間 |
CallLog
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| id | 整数 | 通話記録ID |
| call_type | 文字列 | 通話タイプ |
| result | 文字列 | 通話結果 |
| duration | 整数 | 通話時間（秒） |
| created_at | 日時 | 通話作成時間 |
ImSubSession
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| id | 整数 | 会話記録ID |
| platform | 文字列 | 会話プラットフォーム |
| customer_msg_num | 整数 | 顧客メッセージ数 |
| agent_msg_num | 整数 | カスタマーサポートメッセージ数 |
| created_at | 日時 | 会話作成時間 |
CustomerFollowUp
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| id | 整数 | フォローアップ記録ID |
| user_id | 整数 | 記録したカスタマーサポートID |
| content | 文字列 | 記録内容 |
| created_at | 日時 | フォローアップ記録作成時間 |
| agent_name | 文字列 | カスタマーサポートニックネーム |
Alternation
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| time | 日時 | 変更発生時間 |
| author | オブジェクト | 操作者 |
| summary | 文字列 | 変更説明 |
ここで、authorの形式は以下の通りです：
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| id | 整数 | カスタマーサポートID |
| nick_name | 文字列 | カスタマーサポートニックネーム |
| ### サンプル |
curl https://demo.udesk.cn/open_api_v1/customers/feeds?type=id&content=1&email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
レスポンス
{
"code": 1000,
"feeds": [
{
"feed_type": "Ticket",
"id": 1,
"content": "<p>テストチケット</p>",
"subject": "テストチケット",
"user_id": 1,
"user_group_id": 1,
"status_zh_name": "オープン",
"created_at": "2006-01-02T15:04:05.000+08:00"
},
{
"feed_type": "Alteration",
"time": "2006-01-02T15:04:05.000+08:00",
"author": {
"id": null,
"nick_name": null
},
"summary": "担当者: <空>---->テストサポート1"
}
],
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 6
}
}
顧客フィルターリストの取得
このAPIはすべての顧客フィルター情報を取得するために使用されます。
リクエストメソッド
GET /customers/filters
リクエストパラメータ
なし
レスポンスデータ
| 属性名 | タイプ | 説明 |
|---|---|---|
| code | 整数型 | 実行結果コード、1000は成功を表します |
| customer_filters | 配列 | 顧客フィルターリスト、詳細は以下を参照 |
customer_filters 要素
| 属性名 | タイプ | 説明 |
|---|---|---|
| id | 整数型 | 一意の識別子 |
| name | 文字列 | 名称 |
| active | ブール型 | 有効かどうか |
サンプル
curl https://demo.udesk.cn/open_api_v1/customers/filters?email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
レスポンス
{
"code": 1000,
"customer_filters": [
{
"id": 1,
"name": "テストフィルター1",
"active": true,
},
{
"id": 2,
"name": "テストフィルター2",
"active": false,
}
]
}
カスタマーカスタムフィールドの取得（非推奨）
このAPIは、すべてのカスタマーカスタムフィールド情報を取得するために使用されます。
リクエストメソッド
GET /customers/custom_fields
リクエストパラメータ
なし
レスポンスデータ
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| code | 整数 | 実行結果コード、1000は成功を表します |
| custom_fields | 配列 | カスタマーカスタムフィールドのリスト、詳細は以下を参照 |
custom_fields 要素
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| id | 整数 | 一意の識別子 |
| agent_permission | 整数 | カスタマーサポートの権限 |
| customer_permission | 整数 | カスタマーの権限 |
| custom_field_name | 文字列 | 一意の識別名、通常は"SelectField_"または"TextField_"の接頭辞にidが付きます |
| title | 文字列 | フィールド名 |
| comment | 文字列 | 説明 |
| content_type | 文字列 | タイプ |
| options | 配列 | 選択タイプフィールドのオプション、例を参照 |
agent_permission
| 値 | 意味 |
|---|---|
| 1 | 必須入力 |
| 2 | 任意入力 |
customer_permission
| 値 | 意味 |
|---|---|
| 0 | 不可視 |
| 1 | 可視 |
| 2 | 可視かつ編集可能 |
| 3 | 必須入力 |
例
curl https://demo.udesk.cn/open_api_v1/customers/custom_fields?email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
レスポンス
{
"code": 1000,
"custom_fields": [
{
"id": 1,
"agent_permission": 1,
"customer_permission": 2,
"title": "単行テキストフィールド",
"comment": "",
"content_type": "text",
"custom_field_name": "TextField_1",
"options": null
},
{
"id": 2,
"agent_permission": 1,
"customer_permission": 1,
"title": "複数行テキストフィールド",
"comment": "",
"content_type": "area_text",
"custom_field_name": "TextField_2",
"options": null
},
{
"id": 3,
"agent_permission": 1,
"customer_permission": 3,
"title": "日付フィールド",
"comment": "",
"content_type": "date",
"custom_field_name": "TextField_3",
"options": null
},
{
"id": 4,
"agent_permission": 1,
"customer_permission": 3,
"custom_field_name": "TextField_4",
"title": "時間フィールド",
"content_type": "time",
"comment": "",
"options": null
},
{
"id": 5,
"agent_permission": 1,
"customer_permission": 3,
"custom_field_name": "TextField_5",
"title": "日時フィールド",
"content_type": "datetime",
"comment": "",
"options": null
},
{
"id": 6,
"agent_permission": 1,
"customer_permission": 3,
"custom_field_name": "TextField_6",
"title": "リンクフィールド",
"content_type": "link",
"comment": "",
"options": null
},
{
"id": 7,
"agent_permission": 1,
"customer_permission": 3,
"custom_field_name": "TextField_7",
"title": "正の整数フィールド",
"content_type": "number",
"comment": "",
"options": null
},
{
"id": 8,
"agent_permission": 1,
"customer_permission": 3,
"custom_field_name": "TextField_8",
"title": "数値フィールド",
"content_type": "numeric",
"comment": "",
"options": null
},
{
"id": 1,
"agent_permission": 1,
"customer_permission": 2,
"custom_field_name": "SelectField_1",
"title": "ドロップダウンリストフィールド",
"content_type": "droplist",
"comment": null,
"options": [
{"0": "ドロップダウンオプション1"},
{"1": "ドロップダウンオプション2"},
{"2": "ドロップダウンオプション3"}
]
},
{
"id": 2,
"agent_permission": 1,
"customer_permission": 2,
"custom_field_name": "SelectField_2",
"title": "ラジオボタンフィールド",
"content_type": "radio",
"comment": null,
"options": [
{"0": "ラジオボタンオプション1"},
{"1": "ラジオボタンオプション2"}
]
},
{
"id": 3,
"agent_permission": 1,
"customer_permission": 2,
"custom_field_name": "SelectField_3",
"title": "チェックボックスフィールド",
"content_type": "checkbox",
"comment": null,
"options": [
{"0": "チェックボックスオプション1"},
{"1": "チェックボックスオプション2"},
{"2": "チェックボックスオプション3"},
{"3": "チェックボックスオプション4"}
]
}
]
}
顧客一括インポート
このインターフェースは、複数の顧客情報を一度に作成するために使用します。 注意：このメソッドは1分間に1回のみ呼び出し可能です。
リクエストメソッド
POST /customers/batch_import_async
この機能は非同期です。一度に最大100件の顧客をインポートできます。 インターフェースがcode 1000を返すことは、インポートデータが正常に受信されたことを示すのみで、インポートが完了したことを示すものではありません。 インポート結果を確認する必要がある場合は、通知アドレスを設定する必要があります。インポート完了後、通知アドレスに通知が送信されます。詳細は通知アドレスの設定を参照してください。
リクエストパラメータ（Request Body）
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| customers | 配列 | はい | 顧客情報の配列。詳細は以下を参照 |
customers 要素
| パラメータ名 | タイプ | 必須 | 説明 | 制限 |
|---|---|---|---|---|
| nick_name | 文字列 | はい | 氏名 | 最大255文字 |
| description | 文字列 | いいえ | 説明 | 最大255文字 |
| emails | 配列 | いいえ | メールアドレスの配列 | |
| cellphones | 配列 | いいえ | 電話番号の配列 | |
| organization_id | 整数 | いいえ | 顧客会社ID | |
| owner_id | 整数 | いいえ | 担当カスタマーサポートID | |
| owner_group_id | 整数 | いいえ | 担当カスタマーサポートグループID | |
| level | 文字列 | いいえ | レベル。詳細は顧客データを参照。デフォルトは"normal" | |
| custom_fields | オブジェクト | いいえ | カスタムフィールド。詳細は顧客データを参照 | |
| tags | 文字列 | いいえ | タグ。複数ある場合はカンマ区切り | 最大255文字 |
| open_api_token | 文字列 | いいえ | 外部一意識別子 | 最大255文字 |
| weixins | 配列 | いいえ | WeChat情報 | |
| weixin_minis | 配列 | いいえ | WeChatミニプログラム情報 | |
| ### 返却データ |
| 属性名 | タイプ | 説明 |
|---|---|---|
| code | 整数型 | 実行結果コード、1000は成功を表します |
例
curl https://demo.udesk.cn/open_api_v1/customers/batch_import_async?email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X POST \
-H 'content-type: application/json' \
-d'
{
"customers": [
{
"nick_name": "テスト顧客2",
"emails": ["customer2@sample.com", "customer2@qq.com"],
"cellphones": ["13100000002", "13200000002"],
"owner_id": 1,
"owner_group_id": 1,
"custom_fields": {
"TextField_1": "通常テキスト内容",
"TextField_2": "複数行テキスト内容1\r\n複数行テキスト内容2",
"TextField_3": "2016-08-11",
"TextField_4": "14:44:36",
"TextField_5": "2017-05-03 14:44",
"TextField_6": "https://www.sample.com",
"TextField_7": "13",
"TextField_8": "13.33",
"SelectField_1": ["0"],
"SelectField_2": ["0"],
"SelectField_3": ["0","3"]
},
"weixins": [
{
"appid": "wxf54489a1azz51885",
"openid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk",
"unionid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk"
},
{
"appid": "wxf54489a1azz51885",
"openid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk"
}
],
"weixin_minis": [
{
"appid": "wxc7279f8eefd70a4a",
"openid": "oa3cT0mano9wVhIpkp3drqy9yDuw",
"unionid": "sadgsathGdfsgBfhkfhgddfxzfAs"
},
{
"appid": "wxc7279f8eefd70a4a",
"openid": "asdgasda0mano9hIpkp3drqy9yDuw"
}
]
}
]
}'
返却
{
"code": 1000
}
顧客一括エクスポート
このインターフェースは、大量の顧客情報をエクスポートするために使用されます。 指定されたフィルターで顧客を絞り込むことができます。 キーワードで顧客を検索することができます。
リクエスト方法
GET /customers/export
このインターフェースの使用方法:
filter_idまたはqueryを使用してこのインターフェースを呼び出します。結果には最初のバッチのデータとscroll_idが含まれます。- データ処理が完了したら、前回の呼び出しで返された
scroll_idを使用して再度このインターフェースを呼び出します（この時、filter_idまたはqueryを再度渡す必要はありません）。結果には2番目のバッチのデータと新しいscroll_idが含まれます。 - 返される結果の
customersが空になるまで、ステップ2を繰り返します。
注意:
1. 以降の各呼び出しでは、前回の呼び出しで返された新しい scroll_id を使用する必要があります。scroll_id は1分後に期限切れになります。
2. filter_id パラメータが誤っている場合、フィルターなし（つまり全顧客を返す）でクエリが実行されます。
リクエストパラメータ（Query String）
| パラメータ名 | タイプ | 必須 | 説明 | 制限 |
|---|---|---|---|---|
| filter_id | 整数 | いいえ | 顧客フィルターID。このフィルターの絞り込み結果をエクスポートします。 | |
| query | 文字列 | いいえ | 顧客検索時のキーワード。このキーワードの検索結果をエクスポートします。 | |
| scroll_id | 文字列 | いいえ | 次のバッチのデータを取得するためのID。前回の本インターフェース呼び出しの結果から取得します。 |
レスポンスデータ
| 属性名 | タイプ | 説明 |
|---|---|---|
| code | 整数 | 実行結果コード。1000は成功を表します。 |
| scroll_id | 文字列 | 次のバッチのデータを取得するためのID。 |
| total | 整数 | データ総数。 |
| customers | 配列 | 顧客リスト。詳細は顧客データを参照してください。 |
注意: 一度に取得できる
customersの最大数は1000件です。返される結果のcustomersの数が0の場合、エクスポートが終了したことを意味します。
例
# 最初の呼び出し
curl https://demo.udesk.cn/open_api_v1/customers/export?email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
&filter_id=1
# 以降の呼び出し
curl https://demo.udesk.cn/open_api_v1/customers/export?email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
&scroll_id=DnF1ZXJ5VGhlbkZldGNoBQAAAAAAAABHFnVvTTZEQXFwUkZ5S2wtSkdabmVBbWcAAAAAAAAASBZ1b002REFxcFJGeUtsLUpHWm5lQW1nAAAAAAAAAEkWdW9NNkRBcXBSRnlLbC1KR1puZUFtZwAAAAAAAABKFnVvTTZEQXFwUkZ5S2wtSkdabmVBbWcAAAAAAAAASxZ1b002REFxcFJGeUtsLUpHWm5lQW1n
レスポンス
{
"code": 1000,
"scroll_id": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAAABHFnVvTTZEQXFwUkZ5S2wtSkdabmVBbWcAAAAAAAAASBZ1b002REFxcFJGeUtsLUpHWm5lQW1nAAAAAAAAAEkWdW9NNkRBcXBSRnlLbC1KR1puZUFtZwAAAAAAAABKFnVvTTZEQXFwUkZ5S2wtSkdabmVBbWcAAAAAAAAASxZ1b002REFxcFJGeUtsLUpHWm5lQW1n",
"total": 10000,
"customers": [...]
}
データ構造-顧客
顧客
| 属性名 | タイプ | 説明 | 制限 |
|---|---|---|---|
| id | 整数型 | 一意の識別子 | |
| nick_name | 文字列 | 氏名 | 最大長255文字 |
| level | 文字列 | 顧客レベル | |
| description | 文字列 | 説明 | 最大長255文字 |
| owner_id | 整数型 | 担当カスタマーサポートID | |
| owner_group_id | 整数型 | 担当カスタマーサポートグループID | |
| custom_fields | オブジェクト | カスタムフィールド、詳細は以下のカスタムフィールド説明を参照 | |
| open_api_token | 文字列 | 外部一意識別子 | 最大長255文字 |
| organization_id | 整数型 | 顧客企業ID | |
| organization_ids | 配列(整数型) | 顧客企業リスト | |
| default_organization_id | 整数型 | デフォルト企業ID | |
| is_blocked | ブール型 | ブラックリストに追加されているかどうか | |
| tags | 配列 | タグリスト、詳細は以下を参照 | |
| rich_tags | 配列 | 背景色付きタグリスト、詳細は以下を参照 | |
| 文字列 | メインEメール | 最大長255文字 | |
| other_emails | 配列 | その他のEメールリスト | |
| cellphones | 配列 | 連絡先電話番号リスト | |
| weixins | 配列 | WeChat情報 | |
| platform | 文字列 | 作成チャネル名(中国語)(このフィールドは段階的に廃止予定) | |
| source_channel | 文字列 | 顧客ソース名(中国語) | |
| first_contact_at | 日時 | 初回連絡日時 | |
| last_contact_at | 日時 | 最終連絡日時 | |
| first_contact_at_via_phone | 日時 | 初回電話連絡日時 | |
| last_contact_at_via_phone | 日時 | 最終電話連絡日時 | |
| first_contact_at_via_im | 日時 | 初回オンラインサポート連絡日時 | |
| last_contact_at_via_im | 日時 | 最終オンラインサポート連絡日時 | |
| weixin_minis | 配列 | WeChatミニプログラム情報 | |
| web_token | 文字列 | 顧客Web識別子 | 最大長255文字 |
| sdk_token | 文字列 | 顧客SDK識別子 | 最大長255文字 |
| #### level |
| 値 | 意味 |
|---|---|
| normal | 通常 |
| vip | VIP |
source_channel
| 日本語名 | 英語名 |
|---|---|
| 手動作成 | manual |
| 電話着信 | callin |
| 電話発信 | callout |
| 微信 | |
| 微博 | |
| オンラインサポート | web_im |
| APIまたはSDK | api |
| フィードバックフォーム | feedback |
| メール | |
| 一括インポート | import |
| 企業微信 | qywx |
| 微信カスタマーサービス番号 | weixin_kf |
| 微信ミニプログラム | weixin_mini |
| 百度BCP | baidu |
| ツイッター | |
| Line | line |
| 抖音企業アカウント | tiktok |
| ビデオサポート | mpv |
platform
| 日本語名 | 英語名 |
|---|---|
| メール | |
| 微博 | |
| 微信 | |
| インスタントメッセージ | im |
| 電話 | call |
| フィードバックタグ | feedback |
| ヘルプセンター | hc |
| 手動入力 | manual_input |
| API | api |
tags
| 属性名 | 型 | 説明 |
|---|---|---|
| id | 整数型 | タグID |
| name | 文字列 | タグ名 |
| company_id | 整数型 | 会社ID（現在は用途なし） |
rich_tags
| 属性名 | 型 | 説明 |
|---|---|---|
| id | 整数型 | タグID |
| name | 文字列 | タグ名 |
| color | 文字列 | タグの色 |
| company_id | 整数型 | 会社ID（現在は用途なし） |
custom_fields
custom_fields の例：
{
"custom_fields": {
"TextField_1": "通常テキスト内容", // 通常テキスト
"TextField_2": "複数行テキスト内容1\r\n複数行テキスト内容2", // 複数行テキスト
"TextField_3": "2016-08-11", // 日付
"TextField_4": "14:44:36", // 時間
"TextField_5": "2017-05-03 14:44", // 日時
"TextField_6": "https://www.sample.com", // リンク
"TextField_7": "13", // 正の整数
"TextField_8": "13.33", // 数値
"SelectField_1": ["0"], // ドロップダウンリスト、ドロップダウンオプション1
"SelectField_2": ["0"], // ラジオボタン、ラジオボタンオプション1
"SelectField_3": ["0","3"] // チェックボックス、チェックボックスオプション1、チェックボックスオプション4
}
}
顧客情報の統合
このAPIは、2つの顧客の情報を統合するために使用されます。
リクエストメソッド
POST /customers/merge
リクエストパラメータ（クエリストリング）
| パラメータ名 | タイプ | 必須 | 説明 | 制限 |
|---|---|---|---|---|
| from_type | 文字列 | はい | from_type 条件タイプ。統合後に削除される顧客を検索するために使用します。詳細は以下を参照してください。 | |
| from_content | 文字列 | はい | from_content 条件内容。統合後に削除される顧客を検索するために使用します。 | |
| to_type | 文字列 | はい | to_type 条件タイプ。統合後に保持される顧客を検索するために使用します。詳細は以下を参照してください。 | |
| to_content | 文字列 | はい | to_content 条件内容。統合後に保持される顧客を検索するために使用します。 |
条件タイプ
| 値 | 対応するcontentの意味 |
|---|---|
| 顧客メールアドレス | |
| cellphone | 顧客電話番号 |
| customer_token | 顧客外部一意識別子 |
| weixin_openid | 顧客WeChat openid |
| weibo_openid | 顧客Weibo openid |
| sdk_token | 顧客SDK識別子 |
| web_token | 顧客Web識別子 |
| weixin_mini_openid | 顧客ミニアプリ openid |
レスポンスデータ
| プロパティ名 | タイプ | 説明 |
|---|---|---|
| code | 整数 | 実行結果コード。1000は成功を表します。 |
| id | 整数 | 統合後に保持された顧客のID。 |
例
curl https://demo.udesk.cn/open_api_v1/customers/merge?email=admin@udesk.cn×tamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X POST \
-H 'content-type: application/json' \
-d '
{
"from_type": "email",
"from_content": "from_customer@sample.com",
"to_type": "email",
"to_content": "to_customer@sample.com"
}'
レスポンス
{
"code": 1000,
"id": 27
}
コードエラーコード説明
| エラーコード | message情報 | exception:message情報 | 説明 |
|---|---|---|---|
| 429 | APIインターフェースがリクエスト制限を超過しました | なし | このインターフェースのリクエスト頻度が制限を超えています |
| 2000 | 不明なエラー | カスタムフィールド XXX が不足しています | カスタムフィールドを必須に設定した場合、パラメータ{custom_fields}が未入力または要件を満たしていません |
| パラメータが不足しているか値が空です: customer | {customer}にパラメータが含まれていません | ||
| メールアドレス重複：customer id = XXX | {email}パラメータはidがXXXの顧客ですでに使用されています | ||
| web_token重複: XXX | {web_token}パラメータはすでに使用されています | ||
| web_tokenフォーマットエラー: XXX | {web_token}パラメータのフォーマットが要件を満たしていません | ||
| web_tokenは文字列でなければなりません | {web_token}パラメータは必須です | ||
| 不正なパラメータフォーマット | 渡されたパラメータのフォーマットが間違っています | ||
| 検証失敗: メールアドレスが無効です | {email}パラメータのフォーマットが間違っています | ||
| WeChat情報(appid: XXX, openid: XXX)はすでに顧客(id: XXX)に存在します | このWeChat情報はidがXXXの顧客ですでに使用されています | ||
| WeChatミニプログラム情報(appid: XXX}, openid: XXX)はすでに顧客(id: XXX)に存在します | このWeChatミニプログラム情報はidがXXXの顧客ですでに使用されています | ||
| 検証失敗: 電話番号XXXはすでに使用されています | {cellphones}内の電話番号はすでに使用されています | ||
| 会社idが存在しません | {organization_id}パラメータが間違っています | ||
| オペレーターが見つかりません | パラメータ{owner_id}が間違っています | ||
| オペレーターは存在しますがオペレーターグループが存在しません | オペレーターid{owner_id}のみを入力した場合、正しい{owner_group_id}も入力する必要があります | ||
| 会社にこのオペレーターグループはありません | {owner_group_id}パラメータが間違っています | ||
| オペレーターはこのオペレーターグループに属していません | パラメータ{owner_group_id}と{owner_id}が一致しません | ||
| 'xxx' は有効なレベルではありません | パラメータ{level}に入力された値が有効範囲内にありません | ||
| undefined method `each' for \"qweasd\":String | 输入的{custom_fields}参数格式错误 | ||
| undefined method `each_with_index' for nil:NilClass | {customer}パラメータが空の配列またはnull、またはこのパラメータが未入力です | ||
| インポートデータが空です | 顧客データのインポートが空です | ||
| インポート数量(XXX)は100を超えることはできません | 顧客のインポート数量が最大制限の100を超えています | ||
| 顧客のマージに失敗しました: 自分自身とマージすることはできません | なし | ユーザーをマージする際、2つのフィールドが同じ顧客を指しています | |
| 無効な一意識別子タイプ | なし | 必須パラメータが未入力です | |
| Couldn't find Customer | なし | 必須パラメータが未入力です | |
| 2005 | 該当リソースが見つかりませんでした | Couldn't find Customer | 提供されたパラメータ{content}に一致するデータが見つかりませんでした |
| 2060 | 無効な一意識別子タイプ | 無効な一意識別子タイプ | {typeパラメータ}が渡されていません |
| 2062 | パラメータエラー | 顧客情報の取得に失敗しました | {filter_id}または{scroll_id}パラメータが間違っています |
| 206211 | パラメータpage_sizeが不正です | なし | パラメータ{page_size}が有効範囲内にありません |
| 206201 | パラメータpageが不正です | なし | パラメータ{page}が有効範囲内にありません |