会社リストの取得

このAPIは、複数の顧客会社情報を一度に取得するために使用されます。

リクエストメソッド

GET /organizations

リクエストパラメータ（クエリストリング）

パラメータ名 必須 タイプ 説明 制限
filter_id いいえ 整数 会社フィルターID フィルターが存在すること
query いいえ 文字列 検索キーワード
page いいえ 整数 ページ番号（1から開始、デフォルトは1） 1〜100
per_page いいえ 整数 1ページあたりの件数（デフォルト100） 1〜100

レスポンスデータ

属性名 タイプ 説明
code 整数 実行結果コード（1000は成功を表します）
meta オブジェクト ページネーション情報。詳細は共通データをご覧ください。
organizations 配列 顧客会社リスト。詳細は会社データをご覧ください。

例

curl https://demo.udesk.cn/open_api_v1/organizations?page=1&per_page=10&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス

{
    "code": 1000,
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 1
    },
    "organizations": [
        {
            "id": 1,
            "name": "テスト会社1",
            "domains": "https://www.test1.com",
            "level": "normal",

            "custom_fields": {
                "TextField_1": "テストテキスト",
                "SelectField_1": ["0"]
            },
            "updated_at": "2017-08-18T12:06:02.000+08:00",
            "description": "この会社は例示のみに使用されます",
            "token": "123456s7hgfd",
            "cellphones": [
              {"id":173,"content":"13111111111"}
            ]
        }
    ]
}

会社詳細の取得

このAPIは、指定された条件に一致する顧客会社の情報を取得するために使用されます。

リクエストメソッド

GET /organizations/show_org

リクエストパラメータ（クエリストリング）

パラメータ名 必須 タイプ 説明 制限
type はい 文字列 条件タイプ 255文字以内
content はい 文字列 条件内容 255文字以内

typeの取り得る値

値 意味
id 会社ID
name 会社名
token 会社外部識別子

例

type = id，content = 1 type = name，content = test_name type = token，content = test_token

レスポンスデータ

属性名 タイプ 説明
code 整数 実行結果コード、1000は成功を表します
organization オブジェクト 顧客会社情報、詳細は会社データを参照してください

例

curl https://demo.udesk.cn/open_api_v1/organizations/show_org?type=name&content=テスト会社1&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス

{
    "code": 1000,
    "organization": {
        "id": 1,
        "name": "テスト会社1",
        "domains": "https://www.test1.com",
        "custom_fields": {
            "TextField_1": "テストテキスト",
            "SelectField_1": ["0"]
        },
        "updated_at": "2017-08-18T12:06:02.000+08:00",
        "description": "この会社は例示のみに使用されます",
        "token": "123456s7hgfd"
    }
}

会社の顧客リストの取得

このAPIは、指定された条件に一致する会社の顧客情報を取得するために使用されます。

リクエスト方法

GET /organizations/customers

リクエストパラメータ（Query String）

パラメータ名 必須 タイプ 説明 制限
type はい 文字列 条件タイプ。会社詳細取得APIを参照してください。 255文字以内
content はい 文字列 条件内容。会社詳細取得APIを参照してください。 255文字以内
page いいえ 整数 ページ番号。1から開始、デフォルトは1。
page_size いいえ 整数 1ページあたりの件数。デフォルト20、最大100。

レスポンスデータ

属性名 タイプ 説明
code 整数 実行結果コード。1000は成功を表します。
meta オブジェクト ページネーション情報。共通データを参照してください。
customers 配列 顧客リスト。顧客データを参照してください。

例

curl https://demo.udesk.cn/open_api_v1/organizations/customers?type=id&content=1&page=1&page_size=10&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス

{
    "code": 1000,
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 1
    },
    "customers": [
        {
            "id": 3,
            "nick_name": "大大1",
            "level": "normal",
            "description": null,
            "tags": [],
            "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,
            "owner_id": null,
            "owner_group_id": null,
            "custom_fields": {},
            "open_api_token": null,
            "email": "",
            "other_emails": [],
            "organization_id": 1,
            "cellphones": [
                {"id": 5, "content": "12333334444"}
            ],
            "wechat": [],
            "weibo": []
        }
    ]
}

会社を作成

このAPIは顧客会社を作成するために使用されます。

リクエストメソッド

POST /organizations

リクエストパラメータ（Request Body）

パラメータ名 タイプ 必須 説明
organization オブジェクト はい 会社情報

organization

パラメータ名 タイプ 必須 説明 制限
name 文字列 はい 名称 255文字以内
description 文字列 いいえ 説明 255文字以内
domains 文字列 いいえ ドメイン
custom_fields オブジェクト いいえ カスタムフィールド

レスポンスデータ

会社詳細を取得 と同じです。

例

curl https://demo.udesk.cn/open_api_v1/organizations?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
 \
-X POST \
-H 'content-type: application/json' \
-d '
{
    "organization": {
        "name": "テスト会社1",
        "description": "テスト会社1の説明",
        "notes": "",
        "domains": "https://www.test1.com",
        "custom_fields": {
            "TextField_1": "テストテキスト",
            "SelectField_1": ["0"]
        },
        "token": "123456s7hgfd"
    }
}'

レスポンス

{
    "code": 1000,
    "organization": {
        "id": 1,
        "name": "テスト会社1",
        "domains": "https://www.test1.com",
        "created_at": "2015-01-02T15:04:05.000+08:00",
        "token": "123456s7hgfd",
        "custom_fields": {
            "TextField_1": "テストテキスト",
            "SelectField_1": ["0"]
        },
        "description": "テスト会社1の説明",
        "customer_count": 0
    }
}

会社情報を更新

このインターフェースは、指定された条件に一致する顧客会社の情報を変更するために使用されます。

リクエストメソッド

PUT /organizations/update_org

リクエストパラメータ（Query String）

会社詳細情報取得インターフェースと同じです。

リクエストパラメータ（Request Body）

パラメータ名 タイプ 必須 説明
organization オブジェクト はい 会社情報。会社データを参照してください。

会社のTokenが存在する場合は変更できません。存在しない場合は変更可能です。

レスポンスデータ

[会社詳細情報取得][]と同じです。

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/organizations/update_org?type=name&content=テスト会社1&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X PUT \
-H 'content-type: application/json' \
-d '
{
    "organization": {
        "description": "テスト会社1の説明文",
    }
}'

レスポンス

{
    "code": 1000,
    "organization": {
        "id": 1,
        "name": "テスト会社1",
        "domains": "https://www.test1.com",
        "created_at": "2015-01-02T15:04:05.000+08:00",
        "custom_fields": {
            "TextField_1": "テストテキスト",
            "SelectField_1": ["0"]
        },
        "description": "テスト会社1の説明文",
        "token": "123456s7hgfd",
        "customer_count": 0
    }
}

会社を削除

このインターフェースは、指定された条件に一致する顧客会社を削除するために使用されます。

リクエストメソッド

DELETE /organizations/destroy_org

リクエストパラメータ（Query String）

会社詳細情報取得インターフェースと同じです。

レスポンスデータ

属性名 タイプ 説明
code 整数型 実行結果コード。1000は成功を表します。
id 整数型 削除された会社のID。
### サンプル 
curl https://demo.udesk.cn/open_api_v1/organizations/destroy_org?type=name&content=テスト会社1&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X DELETE

レスポンス

{
    "code": 1000,
    "id": 1
}

企業カスタムフィールドの取得（廃止）

このAPIは、すべての企業カスタムフィールドのリストを取得するために使用されます。

リクエストメソッド

GET /organizations/custom_fields

リクエストパラメータ

なし

レスポンスデータ

プロパティ名 タイプ 説明
code 整数 実行結果コード、1000は成功を表します
custom_fields 配列 企業カスタムフィールドのリスト。詳細は企業データを参照してください

サンプル

curl https://demo.udesk.cn/open_api_v1/organizations/custom_fields?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス

{
    "code": 1000,
    "custom_fields": [
        {
            "id":10,
            "field_name":"TextField_10",
            "field_title":"ブラウザ",
            "content_type":"text",
            "comment":"",
            "options": null,
            "permission":3,
            "requirment":false
        },
        {
            "id":11,
            "field_name":"SelectField_11",
            "field_title":"連動都市",
            "content_type":"chained_droplist",
            "comment":"内容",
            "options": [{"0":["北京市", [["海淀区", [["知春路"]]]]]}, {"1":["天津市", [["和平区"]]]}],
            "permission":2,
            "requirment":false
        }
    ]
}

データ構造-会社

属性名 タイプ 変更可能 説明
id 整数型 いいえ 一意の識別子
name 文字列 はい 名称
domains 文字列 はい ドメイン
created_at 日時 いいえ 作成日時
updated_at 日時 いいえ 最終更新日時
custom_fields オブジェクト はい カスタムフィールド
description 文字列 はい 説明
customer_count 整数型 いいえ 顧客数
token 文字列 いいえ 顧客会社のToken
level 会社レベル いいえ 取り得る値（normal、vip）顧客が所属するいずれかの会社がvipの場合、この顧客はvip顧客と見なされます

コードエラーコード

エラーコード message情報 exception:message情報 説明
2000 不明なエラー invalid page: xxx pageパラメータの形式が不正です（例：負の数、文字、スペースなど）
不明なエラー なし page_sizeパラメータの形式が不正です
不明なエラー なし 会社作成時にカスタムフィールドを追加した場合、いくつかのカスタムフィールドは設定必須です
不明なエラー 名前が重複しています 会社作成時、会社名が既存の会社と重複しています
不明なエラー Open api tokenは既に存在します 会社作成時、Open api tokenが既存の会社と重複しています
会社は既にtoken値を設定済みです、変更できません なし 会社のtokenが存在する場合は変更不可、存在しない場合は変更可能です
2005 該当リソースが見つかりません Couldn't find Organization with XXX 渡されたidの形式が不正、または渡されたidに対応するリソースが見つかりません
該当リソースが見つかりません Couldn't find Organization with XXX 渡されたnameの形式が不正、または渡されたnameに対応するリソースが見つかりません
該当リソースが見つかりません Couldn't find Organization with XXX 渡されたtokenの形式が不正、または渡されたtokenに対応するリソースが見つかりません
2015 管理者のみ操作可能です 管理者のみ操作可能です API呼び出し時のメールアドレスは管理者のものである必要があります。管理者以外は操作できません
2059 open apiの署名が不正です open apiの署名が不正です open apiの署名が不正です。詳細は認証のドキュメントを参照してください
206201 パラメータpageが不正です なし 範囲: 1から100
206202 パラメータper_pageが不正です なし 範囲: 1から100