{"info":{"title":"CallConnect REST API仕様"},"swagger":"2.0","produces":["application/json"],"host":"nlbhib5563.execute-api.ap-northeast-1.amazonaws.com","tags":[{"name":"common","description":"API共通仕様"},{"name":"contacts","description":"顧客情報API"},{"name":"groups","description":"着信グループAPI"},{"name":"records","description":"通話履歴API"},{"name":"tels","description":"電話番号API"},{"name":"users","description":"ユーザーAPI"}],"paths":{"/v1/common/ping":{"get":{"summary":"認証チェック","description":"\u003cp\u003e- \u003cb\u003ehttps://nlbhib5563.execute-api.ap-northeast-1.amazonaws.com\u003c/b\u003e をホストURLとして呼び出してください。\u003c/p\u003e\u003cp\u003e- X-Callconnect-Token はCallConnectの [管理] [連携] [CallConnect API]より取得できます。\u003c/p\u003e\u003cp\u003e- APIリクエストには、HTTPヘッダ `X-Callconnect-Token` を付与してリクエスト送信します。\u003c/p\u003e\u003cp\u003e- 自社のAPIトークンが第三者に知られないよう大切に管理してください。\u003c/p\u003e","produces":["application/json"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true}],"responses":{"200":{"description":"リクエストを受け付けました。"},"201":{"description":"リソースが作成されました。"},"400":{"description":"不正なリクエストです。"},"401":{"description":"Tokenが不正です。"},"404":{"description":"リソースが見つかりません。"},"500":{"description":"サーバー内でエラーが発生しました。"}},"tags":["common"],"operationId":"getV1CommonPing"}},"/v1/contacts/{id}":{"delete":{"summary":"顧客の削除","description":"顧客情報を削除すると、顧客情報に紐付いた通話履歴も全て削除されます。","produces":["application/json"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"path","name":"id","description":"顧客id","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"顧客の削除"},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["contacts"],"operationId":"deleteV1ContactsId"},"put":{"summary":"顧客の更新","description":"\u003cp\u003e既に別の顧客で更新予定の電話番号が登録されていた場合、400 Invalid Requestを返します。\u003c/p\u003e","produces":["application/json"],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"path","name":"id","description":"顧客id","type":"integer","format":"int32","required":true},{"in":"formData","name":"friendly_number","description":"数字と+,-(任意)からなる電話番号","type":"string","required":false},{"in":"formData","name":"name","description":"氏名","type":"string","required":false},{"in":"formData","name":"company","description":"会社名","type":"string","required":false},{"in":"formData","name":"email","description":"メールアドレス","type":"string","required":false},{"in":"formData","name":"image_url","description":"画像URL","type":"string","required":false},{"in":"formData","name":"address","description":"住所","type":"string","required":false},{"in":"formData","name":"memo","description":"メモ","type":"string","required":false}],"responses":{"200":{"description":"顧客の更新","schema":{"$ref":"#/definitions/ContactsEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["contacts"],"operationId":"putV1ContactsId"},"get":{"summary":"顧客の取得","description":"","produces":["application/json"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"path","name":"id","description":"顧客id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"顧客の取得","schema":{"$ref":"#/definitions/ContactsEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["contacts"],"operationId":"getV1ContactsId"}},"/v1/contacts":{"post":{"summary":"顧客の作成","description":"\u003cp\u003e一度に多くの顧客データを作成したい場合は、CallConnect APIではなく、CSV連携をご利用ください。\u003c/p\u003e\u003cp\u003e既に同じ電話番号が登録されている場合、400 Invalid Requestを返します。\u003c/p\u003e","produces":["application/json"],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"formData","name":"friendly_number","description":"電話番号","type":"string","required":true},{"in":"formData","name":"name","description":"氏名","type":"string","required":false},{"in":"formData","name":"company","description":"会社名","type":"string","required":false},{"in":"formData","name":"email","description":"メールアドレス","type":"string","required":false},{"in":"formData","name":"image_url","description":"画像URL","type":"string","required":false},{"in":"formData","name":"address","description":"住所","type":"string","required":false},{"in":"formData","name":"memo","description":"メモ","type":"string","required":false}],"responses":{"201":{"description":"顧客の作成","schema":{"$ref":"#/definitions/ContactsEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["contacts"],"operationId":"postV1Contacts"},"get":{"summary":"顧客リストの取得","description":"指定数分を更新日時の新しい順で取得","produces":["application/json"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"query","name":"page","description":"ページ","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"ページごとに取得する件数(最大100)","type":"integer","format":"int32","default":25,"required":false}],"responses":{"200":{"description":"顧客リストの取得","schema":{"$ref":"#/definitions/ContactsEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["contacts"],"operationId":"getV1Contacts"}},"/v1/contacts/search":{"get":{"summary":"顧客リストの検索","description":"検索ワードにマッチする顧客を関連度の高い順で取得します。最大30件まで取得します。30件以上の結果が出るような場合は、検索ワードを絞り込んでください。","produces":["application/json"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"query","name":"word","description":"検索ワード","type":"string","required":true}],"responses":{"200":{"description":"顧客リストの検索","schema":{"$ref":"#/definitions/ContactsEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["contacts"],"operationId":"getV1ContactsSearch"}},"/v1/records/{id}":{"put":{"summary":"通話の更新","description":"","produces":["application/json"],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"path","name":"id","description":"通話id","type":"integer","format":"int32","required":true},{"in":"formData","name":"contact_id","description":"顧客ID. nullの場合は非通知","type":"integer","format":"int32","required":false},{"in":"formData","name":"user_id","description":"対応したユーザID","type":"integer","format":"int32","required":false},{"in":"formData","name":"memo","description":"通話メモ","type":"string","required":false}],"responses":{"200":{"description":"通話の更新","schema":{"$ref":"#/definitions/RecordsEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["records"],"operationId":"putV1RecordsId"},"get":{"summary":"通話の取得(文字化を含む)","description":"","produces":["application/json"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"path","name":"id","description":"通話id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"通話の取得(文字化を含む)","schema":{"$ref":"#/definitions/RecordsShowEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["records"],"operationId":"getV1RecordsId"}},"/v1/records":{"post":{"summary":"通話の作成","description":"通話をAPIから作成すると、\"APIから作成\"のステータスとして履歴に追加されます。","produces":["application/json"],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"formData","name":"contact_id","description":"顧客ID. nullの場合は非通知","type":"integer","format":"int32","required":false},{"in":"formData","name":"user_id","description":"対応したユーザID","type":"integer","format":"int32","required":false},{"in":"formData","name":"memo","description":"通話メモ","type":"string","required":false}],"responses":{"201":{"description":"通話の作成","schema":{"$ref":"#/definitions/RecordsEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["records"],"operationId":"postV1Records"},"get":{"summary":"通話リストの取得","description":"日時の新しい順で取得","produces":["application/json"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"query","name":"page","description":"ページ","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"ページごとに取得する件数(最大100)","type":"integer","format":"int32","default":25,"required":false},{"in":"query","name":"user_id","description":"ユーザーID","type":"integer","format":"int32","required":false},{"in":"query","name":"contact_id","description":"顧客ID","type":"integer","format":"int32","required":false},{"in":"query","name":"tel_id","description":"電話ID","type":"integer","format":"int32","required":false}],"responses":{"200":{"description":"通話リストの取得","schema":{"$ref":"#/definitions/RecordsEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["records"],"operationId":"getV1Records"}},"/v1/records/search":{"get":{"summary":"通話履歴の検索","description":"検索条件にマッチする通話履歴を作成日時の新しい順で取得します。最大30件まで取得します。30件以上の結果が出るような場合は、検索条件を絞り込んでください。","produces":["application/json"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"query","name":"word","description":"検索ワード","type":"string","required":false},{"in":"query","name":"daterange","description":"期間 (yyyy/mm/dd - yyyy/mm/dd)","type":"string","required":false},{"in":"query","name":"tel_id","description":"電話番号ID","type":"integer","format":"int32","required":false},{"in":"query","name":"user_id","description":"ユーザーID","type":"integer","format":"int32","required":false},{"in":"query","name":"tags","description":"タグ (複数の場合スペースなしカンマ,区切り)","type":"string","required":false},{"in":"query","name":"statuses","description":"通話ステータス(200: 発信成功, 201: 受信成功, 300: APIによる作成, 400: 発信失敗, 401: 受信失敗, 402: 営業時間外受信失敗. 複数の場合スペースなしカンマ,区切り)","type":"string","required":false}],"responses":{"200":{"description":"通話履歴の検索","schema":{"$ref":"#/definitions/RecordsEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["records"],"operationId":"getV1RecordsSearch"}},"/v1/tels/{id}/ivr":{"put":{"summary":"応答フロー内のIVR更新","description":"転送先グループのメンバーを変更したいだけの場合はグループ更新APIの使用を検討してください。\u003cbr\u003e応答フロー内のIVR更新APIは応答フローでIVR ON時の応答設定を変更できます。1~4(Basic) or 5(Pro)までのプッシュ操作時の動作設定をJSONの配列形式で指定します。それぞれの配列にはname(転送先名)とaction(数字を押した時の動作)を指定します。actionの配列内にはmode: pc(CallConnect)/ex(外線)/mo(携帯電話)の3種類のいずれかを選択できます。pcを選択した場合は作成済みグループ名を指定してください(groups API参照)。ex/moは半角英数字とハイフンからなる文字列です。actionの配列には3つまでの転送先を指定できます。\u003cbr/\u003e\u003cbr/\u003eJSONsheet_manual例(1を押すとグループAと090-1111-2222, 2を押すとグループBへ転送)\u003cbr/\u003e[{\"name\":\"営業部\",\"action\":[{\"mode\":\"pc\",\"dest\":\"グループA\"},{\"mode\":\"mo\",\"dest\":\"090-1111-2222\"}]},{\"name\":\"開発部\",\"action\":[{\"mode\":\"pc\",\"dest\":\"グループB\"}]}]","produces":["application/json"],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"path","name":"id","description":"電話id","type":"integer","format":"int32","required":true},{"in":"formData","name":"sheet_manual","description":"アクション","type":"string","required":true}],"responses":{"200":{"description":"応答フロー内のIVR更新","schema":{"$ref":"#/definitions/TelsIVRFlowEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["tels"],"operationId":"putV1TelsIdIvr"}},"/v1/tels/{id}/direct":{"put":{"summary":"直通応答フローの更新","description":"転送先グループのメンバーを変更したいだけの場合はグループ更新APIの使用を検討してください。\u003cbr\u003e直通応答フローの更新APIは応答フローのIVR OFF時の応答設定を変更できます。着信を受けた際の鳴らし先をJSON形式で指定します。sheet_direct配列内にはmode: pc(CallConnect)/ex(外線)/mo(携帯電話)の3種類のいずれかを選択できます。pcを選択した場合は作成済みグループ名を指定してください(groups API参照)。ex/moは半角英数字とハイフンからなる文字列です。actionの配列には3つまでの転送先を指定できます。\u003cbr/\u003e\u003cbr/\u003esheet_direct例\u003cbr/\u003e[{\"mode\":\"pc\",\"dest\":\"グループA\"},{\"mode\":\"mo\",\"dest\":\"090-1111-1111\"},{\"mode\":\"ex\",\"dest\":\"03-2222-2222\"}]","produces":["application/json"],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"path","name":"id","description":"電話id","type":"integer","format":"int32","required":true},{"in":"formData","name":"sheet_direct","description":"アクション","type":"string","required":true},{"in":"formData","name":"name","description":"アクション名 例: サポート","type":"string","required":true}],"responses":{"200":{"description":"直通応答フローの更新","schema":{"$ref":"#/definitions/TelsDirectFlowEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["tels"],"operationId":"putV1TelsIdDirect"}},"/v1/tels/{id}":{"put":{"summary":"電話の更新","description":"","produces":["application/json"],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"path","name":"id","description":"電話ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"play_mode","description":"IVR再生モード. direct: ガイダンスなし, record: 音声録音, upload: ファイルアップロード, auto: 機械音声","type":"string","enum":["direct","record","upload","auto"],"required":false},{"in":"formData","name":"first_msg","description":"機械音声","type":"string","required":false},{"in":"formData","name":"is_record","description":"録音フラグ","type":"string","enum":["true","false"],"required":false},{"in":"formData","name":"is_transcribe","description":"録音文字化フラグ","type":"string","enum":["true","false"],"required":false},{"in":"formData","name":"is_call_analytics","description":"録音解析フラグ","type":"string","enum":["true","false"],"required":false},{"in":"formData","name":"is_anonymous_reject","description":"着信拒否フラグ","type":"string","enum":["true","false"],"required":false}],"responses":{"200":{"description":"電話の更新","schema":{"$ref":"#/definitions/TelsEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["tels"],"operationId":"putV1TelsId"},"get":{"summary":"電話の取得","description":"","produces":["application/json"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"path","name":"id","description":"電話id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"電話の取得","schema":{"$ref":"#/definitions/TelsEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["tels"],"operationId":"getV1TelsId"}},"/v1/tels":{"get":{"summary":"電話リストの取得","description":"","produces":["application/json"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true}],"responses":{"200":{"description":"電話リストの取得","schema":{"$ref":"#/definitions/TelsEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["tels"],"operationId":"getV1Tels"}},"/v1/tels/{id}/period":{"delete":{"summary":"営業時間の削除","description":"","produces":["application/json"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"path","name":"id","description":"電話id","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"営業時間の削除"},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["tels"],"operationId":"deleteV1TelsIdPeriod"},"put":{"summary":"営業時間外再生の変更","description":"","produces":["application/json"],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"path","name":"id","description":"電話id","type":"integer","format":"int32","required":true},{"in":"formData","name":"enabled","description":"営業時間外の有効化。","type":"string","enum":["true","false"],"required":false},{"in":"formData","name":"mode","description":"再生モード. record: 音声録音, upload: ファイルアップロード, auto: 機械音声","type":"string","enum":["record","upload","auto"],"required":false},{"in":"formData","name":"message","description":"機械音声","type":"string","required":false}],"responses":{"200":{"description":"営業時間外再生の変更","schema":{"$ref":"#/definitions/PeriodsEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["tels"],"operationId":"putV1TelsIdPeriod"},"get":{"summary":"営業時間外の取得","description":"","produces":["application/json"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"path","name":"id","description":"電話id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"営業時間外の取得","schema":{"$ref":"#/definitions/PeriodsEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["tels"],"operationId":"getV1TelsIdPeriod"}},"/v1/users/{id}":{"put":{"summary":"ユーザーの更新","description":"","produces":["application/json"],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"path","name":"id","description":"ユーザーid","type":"integer","format":"int32","required":true},{"in":"formData","name":"role","description":"役割 30: 管理者, 20: 書き込み, 10: 読み込み","type":"integer","format":"int32","enum":[30,20,10],"required":false},{"in":"formData","name":"name","description":"名前","type":"string","required":false},{"in":"formData","name":"image_url","description":"画像URL","type":"string","required":false},{"in":"formData","name":"group_ids","description":"所属グループID( \",\"で区切られたグループid)","type":"string","required":false}],"responses":{"200":{"description":"ユーザーの更新","schema":{"$ref":"#/definitions/UsersEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["users"],"operationId":"putV1UsersId"},"get":{"summary":"ユーザーの取得","description":"","produces":["application/json"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"path","name":"id","description":"ユーザーid","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"ユーザーの取得","schema":{"$ref":"#/definitions/UsersEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["users"],"operationId":"getV1UsersId"}},"/v1/users":{"get":{"summary":"ユーザーリストの取得","description":"","produces":["application/json"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true}],"responses":{"200":{"description":"ユーザーリストの取得","schema":{"$ref":"#/definitions/UsersEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["users"],"operationId":"getV1Users"}},"/v1/groups/{id}":{"put":{"summary":"グループメンバーの更新","description":"","produces":["application/json"],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"path","name":"id","description":"グループid","type":"integer","format":"int32","required":true},{"in":"formData","name":"user_ids","description":"\",\"で区切られたメンバーID. users API 参照","type":"string","required":true}],"responses":{"200":{"description":"グループメンバーの更新","schema":{"$ref":"#/definitions/GroupsEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["groups"],"operationId":"putV1GroupsId"},"get":{"summary":"グループの取得","description":"","produces":["application/json"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"path","name":"id","description":"グループid","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"グループの取得","schema":{"$ref":"#/definitions/GroupsEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["groups"],"operationId":"getV1GroupsId"}},"/v1/groups":{"post":{"summary":"グループの作成","description":"","produces":["application/json"],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true},{"in":"formData","name":"name","description":"グループ名","type":"string","required":true},{"in":"formData","name":"user_ids","description":"\",\"で区切られたメンバーID. users API参照","type":"string","required":true}],"responses":{"201":{"description":"グループの作成","schema":{"$ref":"#/definitions/GroupsEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["groups"],"operationId":"postV1Groups"},"get":{"summary":"グループリストの取得","description":"着信先に設定できるグループ一覧です。Userは複数のGroupに所属できます。","produces":["application/json"],"parameters":[{"in":"header","name":"X-Callconnect-Token","description":"CallConnectで発行したAPIトークン","type":"string","required":true}],"responses":{"200":{"description":"グループリストの取得","schema":{"$ref":"#/definitions/GroupsEntity"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid Token"},"403":{"description":"Access Denied"},"404":{"description":"Resource Not Found"},"500":{"description":"Server Error"}},"tags":["groups"],"operationId":"getV1Groups"}}},"definitions":{"ContactsEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"顧客id"},"number":{"type":"string","description":"数字と+(任意)からなる電話番号"},"friendly_number":{"type":"string","description":"数字と+,-(任意)からなる電話番号"},"name":{"type":"string","description":"氏名"},"company":{"type":"string","description":"会社名"},"email":{"type":"string","description":"メールアドレス"},"image_url":{"type":"string","description":"画像URL"},"address":{"type":"string","description":"住所"},"memo":{"type":"string","description":"メモ"},"created_at":{"type":"string","description":"作成日時(ISO8601形式)"},"updated_at":{"type":"string","description":"更新日時(ISO8601形式)"}},"description":"ContactsEntity model"},"RecordsEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"通話id"},"status":{"type":"integer","format":"int32","enum":[200,201,300,400,401,402],"description":"200: 発信成功, 201: 受信成功, 300: APIによる作成, 400: 発信失敗, 401: 受信失敗, 402: 営業時間外受信失敗"},"duration":{"type":"integer","format":"int32","description":"通話時間"},"wait_time":{"type":"integer","format":"int32","description":"キューの待ち時間"},"post_process_duration":{"type":"integer","format":"int32","description":"後処理時間"},"contact_id":{"type":"integer","format":"int32","description":"顧客ID. nullの場合は非通知"},"user_id":{"type":"integer","format":"int32","description":"対応したユーザID"},"tel_id":{"type":"integer","format":"int32","description":"対応した電話ID"},"to":{"type":"string","description":"着信先名"},"voice_url":{"type":"string","description":"録音URL.複数ある場合はカンマ,で区切り"},"memo":{"type":"string","description":"通話メモ"},"created_at":{"type":"string","description":"作成日時(ISO8601形式)"},"updated_at":{"type":"string","description":"更新日時(ISO8601形式)"},"tags":{"$ref":"#/definitions/TagsEntity","description":"タグ"}},"description":"RecordsEntity model"},"TagsEntity":{"type":"object","properties":{"name":{"type":"string","description":"タグ"}}},"RecordsShowEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"通話id"},"status":{"type":"integer","format":"int32","enum":[200,201,300,400,401,402],"description":"200: 発信成功, 201: 受信成功, 300: APIによる作成, 400: 発信失敗, 401: 受信失敗, 402: 営業時間外受信失敗"},"duration":{"type":"integer","format":"int32","description":"通話時間"},"wait_time":{"type":"integer","format":"int32","description":"キューの待ち時間"},"post_process_duration":{"type":"integer","format":"int32","description":"後処理時間"},"contact_id":{"type":"integer","format":"int32","description":"顧客ID. nullの場合は非通知"},"user_id":{"type":"integer","format":"int32","description":"対応したユーザID"},"tel_id":{"type":"integer","format":"int32","description":"対応した電話ID"},"to":{"type":"string","description":"着信先名"},"voice_url":{"type":"string","description":"録音URL.複数ある場合はカンマ,で区切り"},"memo":{"type":"string","description":"通話メモ"},"transcribes":{"type":"string","description":"文字化"},"transcribe_direction":{"type":"string","description":"文字化分類"},"created_at":{"type":"string","description":"作成日時(ISO8601形式)"},"updated_at":{"type":"string","description":"更新日時(ISO8601形式)"},"tags":{"$ref":"#/definitions/TagsEntity","description":"タグ"}},"description":"RecordsShowEntity model"},"TelsIVRFlowEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"電話ID"},"sheet_manual":{"type":"string","description":"IVR"}},"description":"TelsIVRFlowEntity model"},"TelsDirectFlowEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"電話ID"},"sheet_direct":{"type":"string","description":"アクション"}},"description":"TelsDirectFlowEntity model"},"TelsEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"電話ID"},"play_mode":{"type":"string","enum":["direct","record","upload","auto"],"description":"IVR再生モード. direct: ガイダンスなし, record: 音声録音, upload: ファイルアップロード, auto: 機械音声"},"first_msg":{"type":"string","description":"機械音声"},"is_record":{"type":"string","enum":["true","false"],"description":"録音フラグ"},"is_transcribe":{"type":"string","enum":["true","false"],"description":"録音文字化フラグ"},"is_call_analytics":{"type":"string","enum":["true","false"],"description":"録音解析フラグ"},"is_anonymous_reject":{"type":"string","enum":["true","false"],"description":"着信拒否フラグ"},"created_at":{"type":"string","description":"作成日時(ISO8601形式)"},"updated_at":{"type":"string","description":"更新日時(ISO8601形式)"},"twilio_phone":{"$ref":"#/definitions/TelsEntity_TwilioPhonesEntity","description":"Twilio購入番号"}},"description":"TelsEntity model"},"TelsEntity_TwilioPhonesEntity":{"type":"object","properties":{"number":{"type":"string","description":"電話番号"},"friendly_name":{"type":"string","description":"電話番号名"}}},"PeriodsEntity":{"type":"object","properties":{"enabled":{"type":"string","enum":["true","false"],"description":"営業時間外の有効化。"},"mode":{"type":"string","enum":["record","upload","auto"],"description":"再生モード. record: 音声録音, upload: ファイルアップロード, auto: 機械音声"},"message":{"type":"string","description":"機械音声"}},"description":"PeriodsEntity model"},"UsersEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ユーザーid"},"email":{"type":"string","description":"メールアドレス"},"name":{"type":"string","description":"名前"},"role":{"type":"integer","format":"int32","description":"役割 30: 管理者, 20: 書き込み, 10: 読み込み"},"image_url":{"type":"string","description":"画像URL"},"created_at":{"type":"string","description":"作成日時(ISO8601形式)"},"updated_at":{"type":"string","description":"更新日時(ISO8601形式)"},"groups":{"$ref":"#/definitions/UsersEntity_GroupIdsEntity","description":"グループID"}},"description":"UsersEntity model"},"UsersEntity_GroupIdsEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"所属グループID"}}},"GroupsEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"グループid"},"name":{"type":"string","description":"グループ名"},"refered":{"type":"integer","format":"int32","description":"0: 分岐先の設定なし, 1: いずれかのIVRの分岐先に設定済み"},"queue_enabled":{"type":"string","description":"true: キューイング設定フラグ(Proプランのみ)"},"monitor_enabled":{"type":"string","description":"true: モニタリング設定フラグ(Proプランのみ)"},"created_at":{"type":"string","description":"作成日時(ISO8601形式)"},"updated_at":{"type":"string","description":"更新日時(ISO8601形式)"},"users":{"type":"array","items":{"$ref":"#/definitions/GroupsEntity_UserIdsEntity"},"description":"ユーザーID"}},"description":"GroupsEntity model"},"GroupsEntity_UserIdsEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"所属ユーザーID"}}}}}