アンケートリストの取得

このAPIは、会社全体のアンケートテンプレートリストを取得するために使用されます。

リクエストメソッド

GET /questionnaires/questionnaire_list

リクエストパラメータ

パラメータ名 必須 説明
page いいえ ページ番号。1から始まります。デフォルトは1です。
per_page いいえ 1ページあたりの件数。デフォルトは10、最大100です。

レスポンスパラメータ

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

リクエスト例

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

レスポンス例

{
  "code": 1000,
  "questionnaires": [{
    "id": 1,
    "name": "ceshi",
    "status": true,
    "created_at": "2019-01-14T16:01:28.000+08:00"
  }],
  "meta": {
    "current_page": 2,
    "total_pages": 2,
    "total_records": 11
  }
}

アウトバウンドタスクのアンケートデータ取得API

このAPIは、アウトバウンドタスクに関連付けられたアンケート回答リストを取得するために使用されます。

リクエストメソッド

GET /questionnaires/task_questionnaires

リクエストパラメータ

パラメータ名 必須 説明
task_type はい タスクタイプ（手動アウトバウンド："callout_task"； 自動アウトバウンド："ad_task"）
task_id はい 自動アウトバウンドまたは手動アウトバウンドタスクのID
page いいえ ページ番号。1から始まります。デフォルトは1です。
per_page いいえ 1ページあたりの件数。デフォルトは10、最大100です。

レスポンスパラメータ

属性名 タイプ 説明
code 整数 実行結果コード。1000は成功を表します。
meta オブジェクト ページネーション情報。詳細は共通データを参照してください。
customer_questionnaires 配列 アンケート回答リストアンケート回答データ
### リクエスト例 
  curl https://demo.udesk.cn/open_api_v1/questionnaires/task_questionnaires?task_type=callout_task&task_id=210&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス例

{
    "code": 1000,
    "customer_questionnaires": [
        {
            "customer_id": 3933,
            "agent_id": 757,
            "created_at": "2022-03-14T20:17:18.000+08:00",
            "agent_name": "Testerkun",
            "customer_name": "S1qilin",
            "questionnaire_name": "Testerのアンケート",
            "customer_questionnair_id": 639,
            "questionnaire_id": 17,
            "contents": {
                "何をしていますか": "XXX",
                "誰が好きですか": "XXX",
                "テストテスト試合": "XXX"
            }
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_records": 1
    }
}

アンケートデータ取得インターフェース

このインターフェースは、アンケートテンプレートに対応するアンケート回答データのリストを取得するために使用されます。

リクエストメソッド

GET /questionnaires/customer_questionnaires

リクエストパラメータ

パラメータ名 必須 説明
questionnaire_id はい アンケートテンプレートID
page いいえ ページ番号、1から開始、デフォルトは1
per_page いいえ 1ページあたりの件数、デフォルト10、最大100

レスポンスパラメータ

属性名 型 説明
code 整数型 実行結果コード、 1000は成功を表します
meta オブジェクト ページネーション情報、詳細は共通データをご覧ください
customer_questionnaires 配列 アンケート回答データリストアンケート回答データ
### リクエスト例 
curl http://linapp.udeskcat.com/open_api_v1/questionnaires/customer_questionnaires?questionnaire_id=11&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス例

{
  "code": 1000,
  "customer_questionnaires": [{
    "customer_id": 196329,
    "agent_id": 365,
    "created_at": "2019-06-26T19:59:07.000+08:00",
    "agent_name": "bai",
    "customer_name": null,
    "contents": {
      "問題2": null,
      "問題3": "1;2;4",
      "問題1": "2"
    }
  }, {
    "customer_id": 196329,
    "agent_id": 365,
    "created_at": "2019-06-24T18:25:58.000+08:00",
    "agent_name": "bai",
    "customer_name": null,
    "contents": {
      "問題2": "問題2問題2問題2問題2問題2問題2問題2問題2問題2問題2",
      "問題3": "1;2;4",
      "問題1": null,
    }
  }],
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_records": 2
  }
}

アンケート回答データ

属性名 型 説明
customer_id 整数型 回答した顧客ID
agent_id 整数型 回答を収集したエージェントID
created_at 日時型 回答日時
agent_name 文字列型 回答を収集したエージェント名
customer_name 文字列型 回答した顧客名
contents ハッシュ型 回答結果 {"質問"："回答"}。回答がない、または回答が削除された場合のvalueはnullです。 valueは文字列またはnullです
## アンケートテンプレート
属性名 タイプ 説明
id 整数 アンケートテンプレートID
name 文字列 アンケートテンプレート名
status ブール値 アンケートテンプレートの有効状態
created_at 日時 アンケートテンプレート作成時間

コードエラーコード説明

エラーコード message情報 exception_message情報 説明
2005 該当リソースが見つかりません Couldn't find Questionnaire without an ID パラメータidが誤っている、またはデータが見つかりません
13000 存在しないアンケート 無 必須パラメータが追加されていません
13003 アウトバウンドタスクが存在しません 無 パラメータtask_idまたはtask_typeが誤っています