コールトラッカーAPIリファレンス

API Endpoint

https://api.calltracker.jp/ct/3.0a

コールトラッカーVer.3のAPIリファレンスです。

httpsのみを受け付けます。httpによる通信は不可となります。

認証方式は、Basic認証、Cookieセッション認証、OAuth2/Bearerトークン認証から、選択できます。

API実行要求時に事前に認証を必要としません。

各要求毎にAuthorizationヘッダに認証情報を指定(Authorization: Basic (「userid:password」をBase64でエンコード))することでAPI実行を受け入れます。

API実行用のユーザーIDとパスワードは事前にコムスクエアより発行いたします。

API要求時に事前に認証が必要です。

ログインURLにAPI実行用のユーザIDおよびパスワードを与えて認証を要求します。

セッションIDは要求毎に変化するため、API応答毎のSet-Cookieヘッダの値を保持し、使用する必要があります。

API実行用のユーザーIDとパスワードは事前にコムスクエアより発行いたします。

API要求時に事前にアクセストークンの取得が必要です。

トークン発行URLにAPI実行用のユーザーIDパスワードを与えて、トークンの取得を要求します。

認証成功の際は、以降の要求で使用されるアクセストークンと、そのトークンの有効期限、期限切れの際に再発行を要求するためのリフレッシュトークンが応答されます。

API実行要求時はAuthorizationヘッダにトークンを指定(Authorization: Bearer (Token))することでAPI実行を受け入れます。

有効期限を迎える際はトークンのリフレッシュを行うか、再度アクセストークンの取得が必要です。

IPアドレス制限

API実行要求の送信元ホストのIPアドレスによって、実行の制限をかけることが可能です。

Content-TypeをAPI実行のリクエストヘッダに含めることによって、フォーマットを指定可能です。以下の形式が指定可能で、デフォルトはJSON形式になります。

Content-Type	説明
application/x-www-form-urlencoded	API実行パラメータは、ブラウザでフォームをPOSTするときと同じ形式(名前=値&名前=値&…)でHTTPリクエストボディに指定されます。
application/json	API実行パラメータは、JSON形式でHTTPリクエストボディに指定されます。
text/xml	API実行パラメータは、XML形式でHTTPリクエストボディに指定されます。ルート要素の名称は「request」という要素名で固定され、各パラメータのキー名がXML要素名となります。

API実行要求時に、以下のいずれかの指定を行うことによって、その実行結果応答の書式を指定することができます。

要求時、HTTPヘッダにAcceptまたはX-COMSQAPI-Response-Type: (MIME-Type)と指定します。(MIME-Type)部分は、前述の「リクエストパラメータ形式」で指定される形式と同様です。
要求時のパスに_response_type=(TypeName)という問い合わせ文字列を付加する。(TypeName)部分は、「json」「xml」「form」のいずれかを指定できます。

ただし、一部のエラーは、指定した形式にかかわらず、JSONで応答される場合があります。

応答時の主なステータスコードは以下の通りになります。この他のステータスが用いられる場合は、各APIの項目で説明します。(全体共通として、1xx、3xx形式のステータス応答は使用されません。)

ステータスコード	説明
200	要求を正しく実行した。
400	要求内容が正しく解釈できない、各パラメータ値が不正な形式である、など、要求に問題がある場合。
401	認証された要求ではない。事前にログインやトークン発行をしていない、Basic認証の情報が正しくない。
403	禁止された要求。事前に実行されておくべきAPIが実行されていない、設定によって受け付けられない、等の場合。
404	URLに誤りがあるために実行できない。(パスには、API実行する事業者を識別するためのIDなどが含まれるため、それらに誤りがある。)
406	応答書式設定に誤りがあるために実行できない。
409	登録や更新において、競合や重複があるために実行できない。
500	サーバ側で例外発生。

REST APIに対応できない場合

・HTTPメソッドをGETまたはPOST以外に設定できない場合

URLの問い合わせ文字列(QueryString)に_method=(要求したいメソッド名)と加えて代替とすることができます。

状況	URL
実際のURL	DELETE /ct/3.0/foo/bar/xxxxxxxxxxx
代替のURL	GET /ct/3.0/foo/bar/xxxxxxxxxxx?_method=DELETE

URLの問い合わせ文字列(QueryString)に_response_type=(書式[json|xml|form…])と加えて代替とすることができます。

状況	URL
代替のURL	GET /ct/3.0/foo/bar/xxxxxxxxxxx?_response_type=xml

URLの問い合わせ文字列(QueryString)に_force_resok=1と加えます。これを指定すると必ず応答ステータスが200 OKになります。

状況	URL
代替のURL	POST /ct/3.0/foo/bar/xxxxxxxxxxx?_force_resok=1
本来の応答	400 Bad Request
代替の応答	200 OK x-comsqapi-response-status: 400

文字コードは要求・応答共にUTF-8となります。
改行文字は、LFまたはCRLFとなります。
API応答がCSV形式に固定されるなどのもの(ログ取得など)の場合は、各APIによって定められる場合があります。
日付時刻の文字列形式は、ISO-8601に準拠した形式となります。また、APIサーバから応答する日時文字列は"2015-04-01T12:00:00+09:00"といった形式となります。

操作対象の広告主・トラッキング番号が、「管理画面」または「その他のAPI連携」によって作成されたものである場合、CT3API連携からの編集/削除/取得に制限がかかります。

以下の項目は、指定されていても編集を受け付けません。
以下の項目は、取得・一覧取得時に値が返却されません。

項目
dp.deny.action
dp.absence.action
dp.absence.enable
dp.recycle.action
dp.disturb.anonymous.allow
dp.disturb.anonymous.action
dp.preforward.action
dp.fwd.dialing.callingsec
dp.fwd.dialing.action
dp.fwd.dialing.playfile
dp.fwd.cancel.hangup.action
dp.fwd.busy.rotate.action
dp.fwd.busy.hangup.action
dp.fwd.noanswer.rotate.action
dp.fwd.noanswer.hangup.action
dp.fwd.unavailable.rotate.action
dp.fwd.unavailable.hangup.action
dp.fwd.answered.prepare.whispering
dp.fwd.answered.prepare.playfile
dp.fwd.answered.prepare.action
dp.fwd.answered.leg2discon.action
dp.fwd.answered.hangup.action
dp.shutdown.action
dp.fwd.call_queue.enable
dp.fwd.call_rotate.phone
dp.fwd.call_rotate.enable
dp.talkrec.enable
dp.email.enable
dp.email.to
dp.http.enable
dp.fwd.altphone
dp.vars.***

認証 ¶

各種認証方式に応じた認証を行います。

ログイン認証 ¶

POST https://api.calltracker.jp/ct/3.0a/uauth/login/12345678901234567890abcd

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "userid": "userid",
  "password": "password"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "userid": {
      "type": "string",
      "description": "ログインユーザーID"
    },
    "password": {
      "type": "string",
      "description": "ログインパスワード"
    }
  },
  "required": [
    "userid",
    "password"
  ]
}

Responses200400401403404406409500

Headers

Content-Type: application/json
Set-Cookie: luak=xxxxxxxxxxxxxxx; Path=/; Expires=Thu, 21 Dec 2017 09:26:02 GMT

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "trn_tms": "2015-06-25T18:17:24+09:00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "trn_tms": {
      "type": "string",
      "description": "処理成功日時。"
    }
  },
  "required": [
    "trn_id",
    "trn_tms"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

ログイン認証
POST`/uauth/login/{partner}`

Cookieを使ったセッション認証を行う際に利用する、ログインAPIです。
それ以外の認証方式を採用する場合は、本APIは利用しません。
リクエストボディに認証情報を指定してリクエストすると、Set-Cookieヘッダ(セッションIDは"luak"キーの値)にてセッション情報を返します。
認証情報のパラメータについては、右記schemaを参照してください。

URI Parameters

HideShow

partner: string (required) Example: 12345678901234567890abcd
事業者ID

ログアウト ¶

GET https://api.calltracker.jp/ct/3.0a/uauth/logout/12345678901234567890abcd

Responses200400401403404406409500

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "trn_tms": "2015-06-25T18:17:24+09:00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "trn_tms": {
      "type": "string",
      "description": "処理成功日時。"
    }
  },
  "required": [
    "trn_id",
    "trn_tms"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

ログアウト
GET`/uauth/logout/{partner}`

Cookieを使ったセッション認証を行う際に利用する、ログアウトAPIです。
それ以外の認証方式を採用する場合は、本APIは利用しません。

URI Parameters

HideShow

partner: string (required) Example: 12345678901234567890abcd
事業者ID

認証トークン発行 ¶

POST https://api.calltracker.jp/ct/3.0a/uauth/token/12345678901234567890abcd

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "userid": "userid",
  "password": "password"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "userid": {
      "type": "string",
      "description": "ログインユーザーID"
    },
    "password": {
      "type": "string",
      "description": "ログインパスワード"
    }
  },
  "required": [
    "userid",
    "password"
  ]
}

Responses200400401403404406409500

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "trn_tms": "2015-06-25T18:17:24+09:00",
  "result": {
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI4MGRlYmFmMTBlZGUxNDc2YjQyMDg1NWZmZTAxNGU2OTI0ZDNlZDZkOGI5OTE0ZWJkOWFmNTcyZjc1ZmVjYTdlIiwiaWF0IjoxNDY1MzYyNTUzLCJleHAiOjE0NjUzNjQzNTMsInVpZCI6IjU3MzJiMzEwZjQ0ZjBmMThkNDA5ODc5MyIsImF1ZCI6ImNvbXNxLmNvbSIsImlzcyI6ImxvY2FsaG9zdCJ9.U5JgVyQNUs5r8lPJZ3smw8qNukFpy4byWeixdqnQ8V8",
    "token_expire": "2016-05-18T13:54:05+09:00",
    "token_type": "Bearer",
    "refresh_token": "f9fe3f9b0cff8f2160311dc78cb5cca2"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "trn_tms": {
      "type": "string",
      "description": "処理成功日時。"
    },
    "result": {
      "type": "object",
      "properties": {
        "token": {
          "type": "string",
          "description": "アクセストークン"
        },
        "token_expire": {
          "type": "string",
          "description": "アクセストークンの有効期限。"
        },
        "token_type": {
          "type": "string",
          "enum": [
            "Bearer"
          ],
          "description": "アクセストークンの種別。現時点では「Bearer」固定。"
        },
        "refresh_token": {
          "type": "string",
          "description": "リフレッシュ用のトークン。有効期限を超えてトークンを保持する場合は、こちらを使用してアクセストークンを再取得してください。"
        }
      },
      "required": [
        "token",
        "token_expire",
        "token_type",
        "refresh_token"
      ]
    }
  },
  "required": [
    "trn_id",
    "trn_tms",
    "result"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

認証トークン発行
POST`/uauth/token/{partner}`

Oauthトークンを使った認証を行う際に利用する、アクセストークンの取得用APIです。
それ以外の認証方式を採用する場合は、本APIは利用しません。
リクエストボディに認証情報を指定してリクエストすると、レスポンスフィールドにてトークン情報を返します。
認証情報のパラメータについては、右記schemaを参照してください。
レスポンスはJSON形式に限定されます。

URI Parameters

HideShow

partner: string (required) Example: 12345678901234567890abcd
事業者ID

認証トークンリフレッシュ ¶

POST https://api.calltracker.jp/ct/3.0a/uauth/token_refresh/12345678901234567890abcd

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "userid": "userid",
  "refresh_token": "f9fe3f9b0cff8f2160311dc78cb5cca2"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "userid": {
      "type": "string",
      "description": "ログインユーザーID"
    },
    "refresh_token": {
      "type": "string",
      "description": "認証トークン発行、トークンリフレッシュのAPIで応答されるリフレッシュトークンを指定。"
    }
  },
  "required": [
    "userid",
    "refresh_token"
  ]
}

Responses200400401403404406409500

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "trn_tms": "2015-06-25T18:17:24+09:00",
  "result": {
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI4MGRlYmFmMTBlZGUxNDc2YjQyMDg1NWZmZTAxNGU2OTI0ZDNlZDZkOGI5OTE0ZWJkOWFmNTcyZjc1ZmVjYTdlIiwiaWF0IjoxNDY1MzYyNTUzLCJleHAiOjE0NjUzNjQzNTMsInVpZCI6IjU3MzJiMzEwZjQ0ZjBmMThkNDA5ODc5MyIsImF1ZCI6ImNvbXNxLmNvbSIsImlzcyI6ImxvY2FsaG9zdCJ9.U5JgVyQNUs5r8lPJZ3smw8qNukFpy4byWeixdqnQ8V8",
    "token_expire": "2016-05-18T13:54:05+09:00",
    "token_type": "Bearer",
    "refresh_token": "f9fe3f9b0cff8f2160311dc78cb5cca2"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "trn_tms": {
      "type": "string",
      "description": "処理成功日時。"
    },
    "result": {
      "type": "object",
      "properties": {
        "token": {
          "type": "string",
          "description": "アクセストークン"
        },
        "token_expire": {
          "type": "string",
          "description": "アクセストークンの有効期限。"
        },
        "token_type": {
          "type": "string",
          "enum": [
            "Bearer"
          ],
          "description": "アクセストークンの種別。現時点では「Bearer」固定。"
        },
        "refresh_token": {
          "type": "string",
          "description": "リフレッシュ用のトークン。有効期限を超えてトークンを保持する場合は、こちらを使用してアクセストークンを再取得してください。"
        }
      },
      "required": [
        "token",
        "token_expire",
        "token_type",
        "refresh_token"
      ]
    }
  },
  "required": [
    "trn_id",
    "trn_tms",
    "result"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

認証トークンリフレッシュ
POST`/uauth/token_refresh/{partner}`

Oauthトークンを使った認証を行う際に利用する、アクセストークンの再取得用APIです。
それ以外の認証方式を採用する場合は、本APIは利用しません。
リクエストボディにリフレッシュトークンを指定してリクエストすると、レスポンスフィールドにて再取得したトークン情報を返します。
リフレッシュトークンのパラメータについては、右記schemaを参照してください。
レスポンスはJSON形式に限定されます。

URI Parameters

HideShow

partner: string (required) Example: 12345678901234567890abcd
事業者ID

広告主管理 ¶

広告主情報の登録・編集・削除・取得を行います。

広告主情報登録 ¶

POST https://api.calltracker.jp/ct/3.0a/clients/12345678901234567890abcd

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "dp.talkrec.enable": true,
  "dp.deny.action": "__play_guidance",
  "dp.absence.action": "__play_guidance_exit",
  "dp.absence.enable": false,
  "dp.recycle.action": "__play_guidance",
  "dp.disturb.anonymous.allow": true,
  "dp.disturb.anonymous.action": "__play_guidance",
  "dp.fwd.dialing.callingsec": 30,
  "dp.preforward.action": "__play_guidance",
  "dp.fwd.dialing.action": "ring",
  "dp.fwd.dialing.playfile": "1234567890abcdef12345678_moh",
  "dp.fwd.cancel.hangup.action": "__email_notify_noguidance",
  "dp.fwd.busy.rotate.action": "__play_guidance",
  "dp.fwd.busy.hangup.action": "__play_guidance",
  "dp.fwd.noanswer.rotate.action": "__play_guidance",
  "dp.fwd.noanswer.hangup.action": "__play_guidance",
  "dp.fwd.unavailable.rotate.action": "__play_guidance",
  "dp.fwd.unavailable.hangup.action": "__play_guidance",
  "dp.fwd.answered.prepare.whispering": true,
  "dp.fwd.answered.prepare.playfile": "1234567890abcdef12345678_voice",
  "dp.fwd.answered.leg2discon.action": "__play_guidance",
  "dp.fwd.answered.hangup.action": "__email_notify_noguidance",
  "dp.fwd.call_rotate.enable": true,
  "dp.fwd.call_rotate.phone": [
    "09012345678",
    "07098765432"
  ],
  "dp.shutdown.action": "__email_notify_noguidance",
  "dp.email.enable": false,
  "dp.email.to": [
    "sample@comsq.com"
  ],
  "dp.http.enable": false,
  "dp.fwd.altphone": "0399999999",
  "dp.vars": {
    "anykey1": "anykey1",
    "anykey2": "anykey2"
  },
  "clientID": "clientA",
  "viewname": "広告主A",
  "dp.phone": "09012345678",
  "dp.forward_enable": true,
  "tags": [
    "test1",
    "test2"
  ],
  "agency": "567856785678567856785678",
  "feepack": "pack050",
  "feepack_num": 1
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "dp.talkrec.enable": {
      "type": "boolean",
      "description": "通話録音を有効にする際にtrueを設定します。"
    },
    "dp.deny.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__donothing"
      ],
      "description": "転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。"
    },
    "dp.absence.action": {
      "type": "string",
      "enum": [
        "__play_guidance_exit",
        "__change_fwd",
        "__hangup",
        "__email_notify_exit",
        "__http_notify_exit",
        "__donothing"
      ],
      "description": "不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。"
    },
    "dp.absence.enable": {
      "type": "boolean",
      "description": "不在設定のON・OFFを設定します。true→不在、false→在席。"
    },
    "dp.recycle.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "リサイクル期間に動作するアクション名を指定します。"
    },
    "dp.disturb.anonymous.allow": {
      "type": "boolean",
      "description": "非通知からの着信拒否を設定します。true→非通知を許可、false→非通知を拒否。"
    },
    "dp.disturb.anonymous.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__donothing"
      ],
      "description": "非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。"
    },
    "dp.fwd.dialing.callingsec": {
      "type": "number",
      "description": "転送先を呼び出す秒数を指定します。指定した秒数を超えると「無応答」と判断されます。"
    },
    "dp.preforward.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__http_notify",
        "__donothing"
      ],
      "description": "呼び出し前に動作するアクション名を指定します。"
    },
    "dp.fwd.dialing.action": {
      "type": "string",
      "enum": [
        "ring",
        "moh",
        "talkie"
      ],
      "description": "呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）"
    },
    "dp.fwd.dialing.playfile": {
      "type": "string",
      "description": "dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。"
    },
    "dp.fwd.cancel.hangup.action": {
      "type": "string",
      "enum": [
        "__email_notify_noguidance",
        "__http_notify_noguidance",
        "__donothing"
      ],
      "description": "転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。"
    },
    "dp.fwd.busy.rotate.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。"
    },
    "dp.fwd.busy.hangup.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。"
    },
    "dp.fwd.noanswer.rotate.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。"
    },
    "dp.fwd.noanswer.hangup.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。"
    },
    "dp.fwd.unavailable.rotate.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。"
    },
    "dp.fwd.unavailable.hangup.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。"
    },
    "dp.fwd.answered.prepare.whispering": {
      "type": "boolean",
      "description": "転送先応答時、入電ガイダンスを再生するときにtrueを指定します。"
    },
    "dp.fwd.answered.prepare.playfile": {
      "type": "string",
      "description": "入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。"
    },
    "dp.fwd.answered.leg2discon.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__donothing"
      ],
      "description": "通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。"
    },
    "dp.fwd.answered.hangup.action": {
      "type": "string",
      "enum": [
        "__email_notify_noguidance",
        "__http_notify_noguidance",
        "__donothing"
      ],
      "description": "通話が成立した際、通話終了時に動作するアクション名を指定します。"
    },
    "dp.fwd.call_rotate.enable": {
      "type": "boolean",
      "description": "順次転送機能を有効にする際にtrueに設定します。"
    },
    "dp.fwd.call_rotate.phone": {
      "type": "array",
      "items": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。"
    },
    "dp.shutdown.action": {
      "type": "string",
      "enum": [
        "__email_notify_noguidance",
        "__http_notify_noguidance",
        "__donothing"
      ],
      "description": "通話終了時に動作するアクション名を指定します。"
    },
    "dp.email.enable": {
      "type": "boolean",
      "description": "メール通知設定を有効にする際に、trueを指定します。"
    },
    "dp.email.to": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。"
    },
    "dp.http.enable": {
      "type": "boolean",
      "description": "Webプッシュ通知設定を有効にする際に、trueを指定します。"
    },
    "dp.fwd.altphone": {
      "type": "string",
      "description": "転送先変更（__change_fwd）設定時の電話番号を指定します。"
    },
    "dp.vars": {
      "type": "object",
      "properties": {
        "anykey1": {
          "type": "string"
        },
        "anykey2": {
          "type": "string"
        }
      },
      "description": "任意のkey-valueを設定できます。"
    },
    "clientID": {
      "type": "string",
      "description": "広告主ID。事業者様にて管理している一意なID。半角英数字、および、-_.@:で、1文字以上指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。"
    },
    "viewname": {
      "type": "string",
      "description": "管理画面や通話ログに出力する広告主の名称。"
    },
    "dp.phone": {
      "type": "string",
      "description": "転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。"
    },
    "dp.forward_enable": {
      "type": "boolean",
      "description": "転送可否。"
    },
    "tags": {
      "type": "array",
      "items": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "広告主に定義するタグを配列で指定します。"
    },
    "agency": {
      "type": "string",
      "description": "代理店のシステム管理ID。"
    },
    "feepack": {
      "type": "string",
      "description": "事業者設定で許可された料金パッケージ指定。マルチバイト文字列は利用できません。"
    },
    "feepack_num": {
      "type": "number",
      "description": "料金パッケージの購入数を指定。"
    }
  },
  "required": [
    "dp.phone",
    "dp.forward_enable"
  ]
}

Responses200400401403404406409500

Headers

Content-Type: application/json

Body

{
  "result": {
    "dp.talkrec.enable": true,
    "dp.deny.action": "__play_guidance",
    "dp.absence.action": "__play_guidance_exit",
    "dp.absence.enable": false,
    "dp.recycle.action": "__play_guidance",
    "dp.disturb.anonymous.allow": true,
    "dp.disturb.anonymous.action": "__play_guidance",
    "dp.fwd.dialing.callingsec": 30,
    "dp.preforward.action": "__play_guidance",
    "dp.fwd.dialing.action": "ring",
    "dp.fwd.dialing.playfile": "1234567890abcdef12345678_moh",
    "dp.fwd.cancel.hangup.action": "__email_notify_noguidance",
    "dp.fwd.busy.rotate.action": "__play_guidance",
    "dp.fwd.busy.hangup.action": "__play_guidance",
    "dp.fwd.noanswer.rotate.action": "__play_guidance",
    "dp.fwd.noanswer.hangup.action": "__play_guidance",
    "dp.fwd.unavailable.rotate.action": "__play_guidance",
    "dp.fwd.unavailable.hangup.action": "__play_guidance",
    "dp.fwd.answered.prepare.whispering": true,
    "dp.fwd.answered.prepare.playfile": "1234567890abcdef12345678_voice",
    "dp.fwd.answered.leg2discon.action": "__play_guidance",
    "dp.fwd.answered.hangup.action": "__email_notify_noguidance",
    "dp.fwd.call_rotate.enable": true,
    "dp.fwd.call_rotate.phone": [
      "09012345678",
      "07098765432"
    ],
    "dp.shutdown.action": "__email_notify_noguidance",
    "dp.email.enable": false,
    "dp.email.to": [
      "sample@comsq.com"
    ],
    "dp.http.enable": false,
    "dp.fwd.altphone": "0399999999",
    "dp.vars": {
      "anykey1": "anykey1",
      "anykey2": "anykey2"
    },
    "clientID": "clientA",
    "viewname": "広告主A",
    "dp.phone": "09012345678",
    "dp.forward_enable": true,
    "tags": [
      "test1",
      "test2"
    ],
    "agency": "567856785678567856785678",
    "feepack": "pack050",
    "feepack_num": 1,
    "_id": "571f22f065a298a60a20ab69"
  },
  "trn_id": "570315a53e3f8b166d12945c",
  "trn_tms": "2015-06-25T18:17:24+09:00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "result": {
      "type": "object",
      "properties": {
        "dp.talkrec.enable": {
          "type": "boolean",
          "description": "通話録音を有効にする際にtrueを設定します。"
        },
        "dp.deny.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。"
        },
        "dp.absence.action": {
          "type": "string",
          "enum": [
            "__play_guidance_exit",
            "__change_fwd",
            "__hangup",
            "__email_notify_exit",
            "__http_notify_exit",
            "__donothing"
          ],
          "description": "不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。"
        },
        "dp.absence.enable": {
          "type": "boolean",
          "description": "不在設定のON・OFFを設定します。true→不在、false→在席。"
        },
        "dp.recycle.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "リサイクル期間に動作するアクション名を指定します。"
        },
        "dp.disturb.anonymous.allow": {
          "type": "boolean",
          "description": "非通知からの着信拒否を設定します。true→非通知を許可、false→非通知を拒否。"
        },
        "dp.disturb.anonymous.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。"
        },
        "dp.fwd.dialing.callingsec": {
          "type": "number",
          "description": "転送先を呼び出す秒数を指定します。指定した秒数を超えると「無応答」と判断されます。"
        },
        "dp.preforward.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__http_notify",
            "__donothing"
          ],
          "description": "呼び出し前に動作するアクション名を指定します。"
        },
        "dp.fwd.dialing.action": {
          "type": "string",
          "enum": [
            "ring",
            "moh",
            "talkie"
          ],
          "description": "呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）"
        },
        "dp.fwd.dialing.playfile": {
          "type": "string",
          "description": "dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。"
        },
        "dp.fwd.cancel.hangup.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。"
        },
        "dp.fwd.busy.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.busy.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.noanswer.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.noanswer.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.unavailable.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.unavailable.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.answered.prepare.whispering": {
          "type": "boolean",
          "description": "転送先応答時、入電ガイダンスを再生するときにtrueを指定します。"
        },
        "dp.fwd.answered.prepare.playfile": {
          "type": "string",
          "description": "入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。"
        },
        "dp.fwd.answered.leg2discon.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。"
        },
        "dp.fwd.answered.hangup.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "通話が成立した際、通話終了時に動作するアクション名を指定します。"
        },
        "dp.fwd.call_rotate.enable": {
          "type": "boolean",
          "description": "順次転送機能を有効にする際にtrueに設定します。"
        },
        "dp.fwd.call_rotate.phone": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ],
          "description": "順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。"
        },
        "dp.shutdown.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "通話終了時に動作するアクション名を指定します。"
        },
        "dp.email.enable": {
          "type": "boolean",
          "description": "メール通知設定を有効にする際に、trueを指定します。"
        },
        "dp.email.to": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。"
        },
        "dp.http.enable": {
          "type": "boolean",
          "description": "Webプッシュ通知設定を有効にする際に、trueを指定します。"
        },
        "dp.fwd.altphone": {
          "type": "string",
          "description": "転送先変更（__change_fwd）設定時の電話番号を指定します。"
        },
        "dp.vars": {
          "type": "object",
          "properties": {
            "anykey1": {
              "type": "string"
            },
            "anykey2": {
              "type": "string"
            }
          },
          "description": "任意のkey-valueを設定できます。"
        },
        "clientID": {
          "type": "string",
          "description": "広告主ID。事業者様にて管理している一意なID。半角英数字、および、-_.@:で、1文字以上指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。"
        },
        "viewname": {
          "type": "string",
          "description": "管理画面や通話ログに出力する広告主の名称。"
        },
        "dp.phone": {
          "type": "string",
          "description": "転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。"
        },
        "dp.forward_enable": {
          "type": "boolean",
          "description": "転送可否。"
        },
        "tags": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ],
          "description": "広告主に定義するタグを配列で指定します。"
        },
        "agency": {
          "type": "string",
          "description": "代理店のシステム管理ID。"
        },
        "feepack": {
          "type": "string",
          "description": "事業者設定で許可された料金パッケージ指定。マルチバイト文字列は利用できません。"
        },
        "feepack_num": {
          "type": "number",
          "description": "料金パッケージの購入数を指定。"
        },
        "_id": {
          "type": "string",
          "description": "システム管理ID。"
        }
      },
      "required": [
        "dp.phone",
        "dp.forward_enable",
        "_id"
      ],
      "description": "APIの実行結果。"
    },
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "trn_tms": {
      "type": "string",
      "description": "処理成功日時。"
    }
  },
  "required": [
    "result",
    "trn_id",
    "trn_tms"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

広告主情報登録
POST`/clients/{partner}`

広告主の登録を行います。
要求を受け付けると、設定された情報で登録し、広告主情報の管理用IDを応答します。
リクエストボディ中に広告主情報に関するパラメータと電話の動作に関するパラメータを指定してリクエストします。パラメータは以下の通りです。
パラメータの値にnullを指定した場合は、そのパラメータの値にnullが登録されます。

要素名	データ型	必須	説明
clientID	string	optional	広告主ID。事業者様にて管理している一意なID。半角英数字、および、-_.@:で、1文字以上指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。
viewname	string	optional	管理画面や通話ログに出力する広告主の名称。
dp.phone	string	required	転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。
dp.forward_enable	boolean	required	転送可否。trueが転送する、falseが転送しない、を表します。
tags	array:string	optional	広告主に付けるタグを指定。複数指定することができます。
agency	string	optional	代理店のシステム管理ID。登録済みの代理店のIDを指定するとその代理店に紐づいた広告主が登録されます。
feepack	string	optional	事業者設定で許可された料金パッケージ指定。マルチバイト文字列は利用できません。
feepack_num	number	optional	料金パッケージの購入数を指定。

要素名	データ型	必須	説明
dp.talkrec.enable	boolean	optional	通話録音を有効にする際にtrueを設定します。
dp.deny.action	enum	optional	転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.absence.action	enum	optional	不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。有償オプションのため、ご利用には事前に申請が必要となります。
dp.absence.enable	boolean	optional	不在設定のON・OFFを設定します。trueが不在、falseが在席を表します。有償オプションのため、ご利用には事前に申請が必要となります。
dp.recycle.action	enum	optional	リサイクル期間に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.disturb.anonymous.allow	boolean	optional	非通知からの着信拒否を設定します。trueが非通知を許可、falseが非通知を拒否する設定を表します。
dp.disturb.anonymous.action	enum	optional	非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.preforward.action	enum	optional	呼び出し前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.dialing.action	enum	optional	呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）
dp.fwd.dialing.playfile	string	optional	dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。
dp.fwd.cancel.hangup.action	enum	optional	転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.busy.rotate.action	enum	optional	順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.busy.hangup.action	enum	optional	転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.noanswer.rotate.action	enum	optional	順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.noanswer.hangup.action	enum	optional	転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.unavailable.rotate.action	enum	optional	順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.unavailable.hangup.action	enum	optional	転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.answered.prepare.whispering	boolean	optional	転送先応答時、入電ガイダンスを再生するときにtrueを指定します。
dp.fwd.answered.prepare.playfile	string	optional	入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。
dp.fwd.answered.leg2discon.action	enum	optional	通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.answered.hangup.action	enum	optional	通話が成立した際、通話終了時に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.call_rotate.enable	boolean	optional	順次転送機能を有効にする際にtrueに設定します。
dp.fwd.call_rotate.phone	array:string	optional	順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。
dp.shutdown.action	enum	optional	通話終了時に動作するアクション名を指定します。
dp.email.enable	boolean	optional	メール通知設定を有効にする際に、trueを指定します。
dp.email.to	array:string	optional	メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。
dp.http.enable	boolean	optional	Webプッシュ通知設定を有効にする際に、trueを指定します。
dp.fwd.altphone	string	optional	転送先変更（__change_fwd）設定時の電話番号を指定します。
dp.vars	object	optional	任意のkey-valueを設定できます。

URI Parameters

HideShow

partner: string (required) Example: 12345678901234567890abcd
事業者ID

広告主情報変更 ¶

PUT https://api.calltracker.jp/ct/3.0a/clients/12345678901234567890abcd/999999999999999999999999

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "dp.talkrec.enable": true,
  "dp.deny.action": "__play_guidance",
  "dp.absence.action": "__play_guidance_exit",
  "dp.absence.enable": false,
  "dp.recycle.action": "__play_guidance",
  "dp.disturb.anonymous.allow": true,
  "dp.disturb.anonymous.action": "__play_guidance",
  "dp.fwd.dialing.callingsec": 30,
  "dp.preforward.action": "__play_guidance",
  "dp.fwd.dialing.action": "ring",
  "dp.fwd.dialing.playfile": "1234567890abcdef12345678_moh",
  "dp.fwd.cancel.hangup.action": "__email_notify_noguidance",
  "dp.fwd.busy.rotate.action": "__play_guidance",
  "dp.fwd.busy.hangup.action": "__play_guidance",
  "dp.fwd.noanswer.rotate.action": "__play_guidance",
  "dp.fwd.noanswer.hangup.action": "__play_guidance",
  "dp.fwd.unavailable.rotate.action": "__play_guidance",
  "dp.fwd.unavailable.hangup.action": "__play_guidance",
  "dp.fwd.answered.prepare.whispering": true,
  "dp.fwd.answered.prepare.playfile": "1234567890abcdef12345678_voice",
  "dp.fwd.answered.leg2discon.action": "__play_guidance",
  "dp.fwd.answered.hangup.action": "__email_notify_noguidance",
  "dp.fwd.call_rotate.enable": true,
  "dp.fwd.call_rotate.phone": [
    "09012345678",
    "07098765432"
  ],
  "dp.shutdown.action": "__email_notify_noguidance",
  "dp.email.enable": false,
  "dp.email.to": [
    "sample@comsq.com"
  ],
  "dp.http.enable": false,
  "dp.fwd.altphone": "0399999999",
  "dp.vars": {
    "anykey1": "anykey1",
    "anykey2": "anykey2"
  },
  "clientID": "clientA",
  "viewname": "広告主A",
  "dp.phone": "09012345678",
  "dp.forward_enable": true,
  "tags": [
    "test1",
    "test2"
  ],
  "agency": "567856785678567856785678"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "dp.talkrec.enable": {
      "type": "boolean",
      "description": "通話録音を有効にする際にtrueを設定します。"
    },
    "dp.deny.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__donothing"
      ],
      "description": "転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。"
    },
    "dp.absence.action": {
      "type": "string",
      "enum": [
        "__play_guidance_exit",
        "__change_fwd",
        "__hangup",
        "__email_notify_exit",
        "__http_notify_exit",
        "__donothing"
      ],
      "description": "不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。"
    },
    "dp.absence.enable": {
      "type": "boolean",
      "description": "不在設定のON・OFFを設定します。true→不在、false→在席。"
    },
    "dp.recycle.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "リサイクル期間に動作するアクション名を指定します。"
    },
    "dp.disturb.anonymous.allow": {
      "type": "boolean",
      "description": "非通知からの着信拒否を設定します。true→非通知を許可、false→非通知を拒否。"
    },
    "dp.disturb.anonymous.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__donothing"
      ],
      "description": "非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。"
    },
    "dp.fwd.dialing.callingsec": {
      "type": "number",
      "description": "転送先を呼び出す秒数を指定します。指定した秒数を超えると「無応答」と判断されます。"
    },
    "dp.preforward.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__http_notify",
        "__donothing"
      ],
      "description": "呼び出し前に動作するアクション名を指定します。"
    },
    "dp.fwd.dialing.action": {
      "type": "string",
      "enum": [
        "ring",
        "moh",
        "talkie"
      ],
      "description": "呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）"
    },
    "dp.fwd.dialing.playfile": {
      "type": "string",
      "description": "dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。"
    },
    "dp.fwd.cancel.hangup.action": {
      "type": "string",
      "enum": [
        "__email_notify_noguidance",
        "__http_notify_noguidance",
        "__donothing"
      ],
      "description": "転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。"
    },
    "dp.fwd.busy.rotate.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。"
    },
    "dp.fwd.busy.hangup.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。"
    },
    "dp.fwd.noanswer.rotate.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。"
    },
    "dp.fwd.noanswer.hangup.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。"
    },
    "dp.fwd.unavailable.rotate.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。"
    },
    "dp.fwd.unavailable.hangup.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。"
    },
    "dp.fwd.answered.prepare.whispering": {
      "type": "boolean",
      "description": "転送先応答時、入電ガイダンスを再生するときにtrueを指定します。"
    },
    "dp.fwd.answered.prepare.playfile": {
      "type": "string",
      "description": "入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。"
    },
    "dp.fwd.answered.leg2discon.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__donothing"
      ],
      "description": "通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。"
    },
    "dp.fwd.answered.hangup.action": {
      "type": "string",
      "enum": [
        "__email_notify_noguidance",
        "__http_notify_noguidance",
        "__donothing"
      ],
      "description": "通話が成立した際、通話終了時に動作するアクション名を指定します。"
    },
    "dp.fwd.call_rotate.enable": {
      "type": "boolean",
      "description": "順次転送機能を有効にする際にtrueに設定します。"
    },
    "dp.fwd.call_rotate.phone": {
      "type": "array",
      "items": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。"
    },
    "dp.shutdown.action": {
      "type": "string",
      "enum": [
        "__email_notify_noguidance",
        "__http_notify_noguidance",
        "__donothing"
      ],
      "description": "通話終了時に動作するアクション名を指定します。"
    },
    "dp.email.enable": {
      "type": "boolean",
      "description": "メール通知設定を有効にする際に、trueを指定します。"
    },
    "dp.email.to": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。"
    },
    "dp.http.enable": {
      "type": "boolean",
      "description": "Webプッシュ通知設定を有効にする際に、trueを指定します。"
    },
    "dp.fwd.altphone": {
      "type": "string",
      "description": "転送先変更（__change_fwd）設定時の電話番号を指定します。"
    },
    "dp.vars": {
      "type": "object",
      "properties": {
        "anykey1": {
          "type": "string"
        },
        "anykey2": {
          "type": "string"
        }
      },
      "description": "任意のkey-valueを設定できます。"
    },
    "clientID": {
      "type": "string",
      "description": "広告主ID。事業者様にて管理している一意なID。半角英数字、および、-_.@:で、1文字以上指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。"
    },
    "viewname": {
      "type": "string",
      "description": "管理画面や通話ログに出力する広告主の名称。"
    },
    "dp.phone": {
      "type": "string",
      "description": "転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。"
    },
    "dp.forward_enable": {
      "type": "boolean",
      "description": "転送可否。"
    },
    "tags": {
      "type": "array",
      "items": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "広告主に定義するタグを配列で指定します。"
    },
    "agency": {
      "type": "string",
      "description": "代理店のシステム管理ID。"
    }
  },
  "required": [
    "dp.phone",
    "dp.forward_enable"
  ]
}

Responses200400401403404406409500

Headers

Content-Type: application/json

Body

{
  "result": {
    "dp.talkrec.enable": true,
    "dp.deny.action": "__play_guidance",
    "dp.absence.action": "__play_guidance_exit",
    "dp.absence.enable": false,
    "dp.recycle.action": "__play_guidance",
    "dp.disturb.anonymous.allow": true,
    "dp.disturb.anonymous.action": "__play_guidance",
    "dp.fwd.dialing.callingsec": 30,
    "dp.preforward.action": "__play_guidance",
    "dp.fwd.dialing.action": "ring",
    "dp.fwd.dialing.playfile": "1234567890abcdef12345678_moh",
    "dp.fwd.cancel.hangup.action": "__email_notify_noguidance",
    "dp.fwd.busy.rotate.action": "__play_guidance",
    "dp.fwd.busy.hangup.action": "__play_guidance",
    "dp.fwd.noanswer.rotate.action": "__play_guidance",
    "dp.fwd.noanswer.hangup.action": "__play_guidance",
    "dp.fwd.unavailable.rotate.action": "__play_guidance",
    "dp.fwd.unavailable.hangup.action": "__play_guidance",
    "dp.fwd.answered.prepare.whispering": true,
    "dp.fwd.answered.prepare.playfile": "1234567890abcdef12345678_voice",
    "dp.fwd.answered.leg2discon.action": "__play_guidance",
    "dp.fwd.answered.hangup.action": "__email_notify_noguidance",
    "dp.fwd.call_rotate.enable": true,
    "dp.fwd.call_rotate.phone": [
      "09012345678",
      "07098765432"
    ],
    "dp.shutdown.action": "__email_notify_noguidance",
    "dp.email.enable": false,
    "dp.email.to": [
      "sample@comsq.com"
    ],
    "dp.http.enable": false,
    "dp.fwd.altphone": "0399999999",
    "dp.vars": {
      "anykey1": "anykey1",
      "anykey2": "anykey2"
    },
    "clientID": "clientA",
    "viewname": "広告主A",
    "dp.phone": "09012345678",
    "dp.forward_enable": true,
    "tags": [
      "test1",
      "test2"
    ],
    "agency": "567856785678567856785678",
    "_id": "571f22f065a298a60a20ab69"
  },
  "trn_id": "570315a53e3f8b166d12945c",
  "trn_tms": "2015-06-25T18:17:24+09:00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "result": {
      "type": "object",
      "properties": {
        "dp.talkrec.enable": {
          "type": "boolean",
          "description": "通話録音を有効にする際にtrueを設定します。"
        },
        "dp.deny.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。"
        },
        "dp.absence.action": {
          "type": "string",
          "enum": [
            "__play_guidance_exit",
            "__change_fwd",
            "__hangup",
            "__email_notify_exit",
            "__http_notify_exit",
            "__donothing"
          ],
          "description": "不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。"
        },
        "dp.absence.enable": {
          "type": "boolean",
          "description": "不在設定のON・OFFを設定します。true→不在、false→在席。"
        },
        "dp.recycle.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "リサイクル期間に動作するアクション名を指定します。"
        },
        "dp.disturb.anonymous.allow": {
          "type": "boolean",
          "description": "非通知からの着信拒否を設定します。true→非通知を許可、false→非通知を拒否。"
        },
        "dp.disturb.anonymous.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。"
        },
        "dp.fwd.dialing.callingsec": {
          "type": "number",
          "description": "転送先を呼び出す秒数を指定します。指定した秒数を超えると「無応答」と判断されます。"
        },
        "dp.preforward.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__http_notify",
            "__donothing"
          ],
          "description": "呼び出し前に動作するアクション名を指定します。"
        },
        "dp.fwd.dialing.action": {
          "type": "string",
          "enum": [
            "ring",
            "moh",
            "talkie"
          ],
          "description": "呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）"
        },
        "dp.fwd.dialing.playfile": {
          "type": "string",
          "description": "dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。"
        },
        "dp.fwd.cancel.hangup.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。"
        },
        "dp.fwd.busy.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.busy.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.noanswer.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.noanswer.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.unavailable.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.unavailable.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.answered.prepare.whispering": {
          "type": "boolean",
          "description": "転送先応答時、入電ガイダンスを再生するときにtrueを指定します。"
        },
        "dp.fwd.answered.prepare.playfile": {
          "type": "string",
          "description": "入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。"
        },
        "dp.fwd.answered.leg2discon.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。"
        },
        "dp.fwd.answered.hangup.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "通話が成立した際、通話終了時に動作するアクション名を指定します。"
        },
        "dp.fwd.call_rotate.enable": {
          "type": "boolean",
          "description": "順次転送機能を有効にする際にtrueに設定します。"
        },
        "dp.fwd.call_rotate.phone": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ],
          "description": "順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。"
        },
        "dp.shutdown.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "通話終了時に動作するアクション名を指定します。"
        },
        "dp.email.enable": {
          "type": "boolean",
          "description": "メール通知設定を有効にする際に、trueを指定します。"
        },
        "dp.email.to": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。"
        },
        "dp.http.enable": {
          "type": "boolean",
          "description": "Webプッシュ通知設定を有効にする際に、trueを指定します。"
        },
        "dp.fwd.altphone": {
          "type": "string",
          "description": "転送先変更（__change_fwd）設定時の電話番号を指定します。"
        },
        "dp.vars": {
          "type": "object",
          "properties": {
            "anykey1": {
              "type": "string"
            },
            "anykey2": {
              "type": "string"
            }
          },
          "description": "任意のkey-valueを設定できます。"
        },
        "clientID": {
          "type": "string",
          "description": "広告主ID。事業者様にて管理している一意なID。半角英数字、および、-_.@:で、1文字以上指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。"
        },
        "viewname": {
          "type": "string",
          "description": "管理画面や通話ログに出力する広告主の名称。"
        },
        "dp.phone": {
          "type": "string",
          "description": "転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。"
        },
        "dp.forward_enable": {
          "type": "boolean",
          "description": "転送可否。"
        },
        "tags": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ],
          "description": "広告主に定義するタグを配列で指定します。"
        },
        "agency": {
          "type": "string",
          "description": "代理店のシステム管理ID。"
        },
        "_id": {
          "type": "string",
          "description": "システム管理ID。"
        }
      },
      "required": [
        "dp.phone",
        "dp.forward_enable",
        "_id"
      ],
      "description": "APIの実行結果。"
    },
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "trn_tms": {
      "type": "string",
      "description": "処理成功日時。"
    }
  },
  "required": [
    "result",
    "trn_id",
    "trn_tms"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

広告主情報変更
PUT`/clients/{partner}/{client}`

広告主情報の変更を行います。
要求を受け付けると、URLパラメータで指定された広告主の情報をリクエストボディの情報に従って変更します。
リクエストボディ中に広告主情報に関するパラメータと電話の動作に関するパラメータを指定してリクエストします。パラメータは以下の通りです。
指定されなかった設定値については変更しません。
パラメータの値の削除には対応していません。

要素名	データ型	必須	説明
clientID	string	optional	広告主ID。事業者様にて管理している一意なID。半角英数字、および、-_.@:で、1文字以上指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。
viewname	string	optional	管理画面や通話ログに出力する広告主の名称。
dp.phone	string	optional	転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。
dp.forward_enable	boolean	optional	転送可否。trueが転送する、falseが転送しない、を表します。
tags	array:string	optional	広告主に付けるタグを指定。複数指定することができます。
agency	string	optional	代理店のシステム管理ID。登録済みの代理店のIDを指定するとその代理店が広告主に紐づきます。広告主配下に番号が発番済みの場合はこの操作を行うことはできません。

要素名	データ型	必須	説明
dp.talkrec.enable	boolean	optional	通話録音を有効にする際にtrueを設定します。
dp.deny.action	enum	optional	転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.absence.action	enum	optional	不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。有償オプションのため、ご利用には事前に申請が必要となります。
dp.absence.enable	boolean	optional	不在設定のON・OFFを設定します。trueが不在、falseが在席を表します。有償オプションのため、ご利用には事前に申請が必要となります。
dp.recycle.action	enum	optional	リサイクル期間に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.disturb.anonymous.allow	boolean	optional	非通知からの着信拒否を設定します。trueが非通知を許可、falseが非通知を拒否する設定を表します。
dp.disturb.anonymous.action	enum	optional	非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.preforward.action	enum	optional	呼び出し前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.dialing.action	enum	optional	呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）
dp.fwd.dialing.playfile	string	optional	dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。
dp.fwd.cancel.hangup.action	enum	optional	転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.busy.rotate.action	enum	optional	順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.busy.hangup.action	enum	optional	転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.noanswer.rotate.action	enum	optional	順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.noanswer.hangup.action	enum	optional	転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.unavailable.rotate.action	enum	optional	順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.unavailable.hangup.action	enum	optional	転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.answered.prepare.whispering	boolean	optional	転送先応答時、入電ガイダンスを再生するときにtrueを指定します。
dp.fwd.answered.prepare.playfile	string	optional	入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。
dp.fwd.answered.leg2discon.action	enum	optional	通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.answered.hangup.action	enum	optional	通話が成立した際、通話終了時に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.call_rotate.enable	boolean	optional	順次転送機能を有効にする際にtrueに設定します。
dp.fwd.call_rotate.phone	array:string	optional	順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。
dp.shutdown.action	enum	optional	通話終了時に動作するアクション名を指定します。
dp.email.enable	boolean	optional	メール通知設定を有効にする際に、trueを指定します。
dp.email.to	array:string	optional	メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。
dp.http.enable	boolean	optional	Webプッシュ通知設定を有効にする際に、trueを指定します。
dp.fwd.altphone	string	optional	転送先変更（__change_fwd）設定時の電話番号を指定します。
dp.vars	object	optional	任意のkey-valueを設定できます。

URI Parameters

HideShow

partner: string (required) Example: 12345678901234567890abcd
事業者ID
client: string (required) Example: 999999999999999999999999
広告主のシステム管理ID

広告主情報削除 ¶

DELETE https://api.calltracker.jp/ct/3.0a/clients/12345678901234567890abcd/999999999999999999999999

Responses200400401403404406409500

Headers

Content-Type: application/json

Body

{
  "result": {
    "dp.talkrec.enable": true,
    "dp.deny.action": "__play_guidance",
    "dp.absence.action": "__play_guidance_exit",
    "dp.absence.enable": false,
    "dp.recycle.action": "__play_guidance",
    "dp.disturb.anonymous.allow": true,
    "dp.disturb.anonymous.action": "__play_guidance",
    "dp.fwd.dialing.callingsec": 30,
    "dp.preforward.action": "__play_guidance",
    "dp.fwd.dialing.action": "ring",
    "dp.fwd.dialing.playfile": "1234567890abcdef12345678_moh",
    "dp.fwd.cancel.hangup.action": "__email_notify_noguidance",
    "dp.fwd.busy.rotate.action": "__play_guidance",
    "dp.fwd.busy.hangup.action": "__play_guidance",
    "dp.fwd.noanswer.rotate.action": "__play_guidance",
    "dp.fwd.noanswer.hangup.action": "__play_guidance",
    "dp.fwd.unavailable.rotate.action": "__play_guidance",
    "dp.fwd.unavailable.hangup.action": "__play_guidance",
    "dp.fwd.answered.prepare.whispering": true,
    "dp.fwd.answered.prepare.playfile": "1234567890abcdef12345678_voice",
    "dp.fwd.answered.leg2discon.action": "__play_guidance",
    "dp.fwd.answered.hangup.action": "__email_notify_noguidance",
    "dp.fwd.call_rotate.enable": true,
    "dp.fwd.call_rotate.phone": [
      "09012345678",
      "07098765432"
    ],
    "dp.shutdown.action": "__email_notify_noguidance",
    "dp.email.enable": false,
    "dp.email.to": [
      "sample@comsq.com"
    ],
    "dp.http.enable": false,
    "dp.fwd.altphone": "0399999999",
    "dp.vars": {
      "anykey1": "anykey1",
      "anykey2": "anykey2"
    },
    "clientID": "clientA",
    "viewname": "広告主A",
    "dp.phone": "09012345678",
    "dp.forward_enable": true,
    "tags": [
      "test1",
      "test2"
    ],
    "agency": "567856785678567856785678",
    "_id": "571f22f065a298a60a20ab69"
  },
  "trn_id": "570315a53e3f8b166d12945c",
  "trn_tms": "2015-06-25T18:17:24+09:00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "result": {
      "type": "object",
      "properties": {
        "dp.talkrec.enable": {
          "type": "boolean",
          "description": "通話録音を有効にする際にtrueを設定します。"
        },
        "dp.deny.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。"
        },
        "dp.absence.action": {
          "type": "string",
          "enum": [
            "__play_guidance_exit",
            "__change_fwd",
            "__hangup",
            "__email_notify_exit",
            "__http_notify_exit",
            "__donothing"
          ],
          "description": "不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。"
        },
        "dp.absence.enable": {
          "type": "boolean",
          "description": "不在設定のON・OFFを設定します。true→不在、false→在席。"
        },
        "dp.recycle.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "リサイクル期間に動作するアクション名を指定します。"
        },
        "dp.disturb.anonymous.allow": {
          "type": "boolean",
          "description": "非通知からの着信拒否を設定します。true→非通知を許可、false→非通知を拒否。"
        },
        "dp.disturb.anonymous.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。"
        },
        "dp.fwd.dialing.callingsec": {
          "type": "number",
          "description": "転送先を呼び出す秒数を指定します。指定した秒数を超えると「無応答」と判断されます。"
        },
        "dp.preforward.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__http_notify",
            "__donothing"
          ],
          "description": "呼び出し前に動作するアクション名を指定します。"
        },
        "dp.fwd.dialing.action": {
          "type": "string",
          "enum": [
            "ring",
            "moh",
            "talkie"
          ],
          "description": "呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）"
        },
        "dp.fwd.dialing.playfile": {
          "type": "string",
          "description": "dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。"
        },
        "dp.fwd.cancel.hangup.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。"
        },
        "dp.fwd.busy.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.busy.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.noanswer.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.noanswer.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.unavailable.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.unavailable.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.answered.prepare.whispering": {
          "type": "boolean",
          "description": "転送先応答時、入電ガイダンスを再生するときにtrueを指定します。"
        },
        "dp.fwd.answered.prepare.playfile": {
          "type": "string",
          "description": "入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。"
        },
        "dp.fwd.answered.leg2discon.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。"
        },
        "dp.fwd.answered.hangup.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "通話が成立した際、通話終了時に動作するアクション名を指定します。"
        },
        "dp.fwd.call_rotate.enable": {
          "type": "boolean",
          "description": "順次転送機能を有効にする際にtrueに設定します。"
        },
        "dp.fwd.call_rotate.phone": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ],
          "description": "順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。"
        },
        "dp.shutdown.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "通話終了時に動作するアクション名を指定します。"
        },
        "dp.email.enable": {
          "type": "boolean",
          "description": "メール通知設定を有効にする際に、trueを指定します。"
        },
        "dp.email.to": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。"
        },
        "dp.http.enable": {
          "type": "boolean",
          "description": "Webプッシュ通知設定を有効にする際に、trueを指定します。"
        },
        "dp.fwd.altphone": {
          "type": "string",
          "description": "転送先変更（__change_fwd）設定時の電話番号を指定します。"
        },
        "dp.vars": {
          "type": "object",
          "properties": {
            "anykey1": {
              "type": "string"
            },
            "anykey2": {
              "type": "string"
            }
          },
          "description": "任意のkey-valueを設定できます。"
        },
        "clientID": {
          "type": "string",
          "description": "広告主ID。事業者様にて管理している一意なID。半角英数字、および、-_.@:で、1文字以上指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。"
        },
        "viewname": {
          "type": "string",
          "description": "管理画面や通話ログに出力する広告主の名称。"
        },
        "dp.phone": {
          "type": "string",
          "description": "転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。"
        },
        "dp.forward_enable": {
          "type": "boolean",
          "description": "転送可否。"
        },
        "tags": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ],
          "description": "広告主に定義するタグを配列で指定します。"
        },
        "agency": {
          "type": "string",
          "description": "代理店のシステム管理ID。"
        },
        "_id": {
          "type": "string",
          "description": "システム管理ID。"
        }
      },
      "required": [
        "dp.phone",
        "dp.forward_enable",
        "_id"
      ],
      "description": "APIの実行結果。"
    },
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "trn_tms": {
      "type": "string",
      "description": "処理成功日時。"
    }
  },
  "required": [
    "result",
    "trn_id",
    "trn_tms"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

広告主情報削除
DELETE`/clients/{partner}/{client}`

広告主情報を削除します。
要求を受け付けると、URLパラメータで指定された広告主の情報を削除します。

URI Parameters

HideShow

partner: string (required) Example: 12345678901234567890abcd
事業者ID
client: string (required) Example: 999999999999999999999999
広告主のシステム管理ID

広告主情報一覧取得 ¶

GET https://api.calltracker.jp/ct/3.0a/clients/12345678901234567890abcd

Responses200400401403404406409500

Headers

Content-Type: application/json

Body

{
  "result": [
    {
      "dp.talkrec.enable": true,
      "dp.deny.action": "__play_guidance",
      "dp.absence.action": "__play_guidance_exit",
      "dp.absence.enable": false,
      "dp.recycle.action": "__play_guidance",
      "dp.disturb.anonymous.allow": true,
      "dp.disturb.anonymous.action": "__play_guidance",
      "dp.fwd.dialing.callingsec": 30,
      "dp.preforward.action": "__play_guidance",
      "dp.fwd.dialing.action": "ring",
      "dp.fwd.dialing.playfile": "1234567890abcdef12345678_moh",
      "dp.fwd.cancel.hangup.action": "__email_notify_noguidance",
      "dp.fwd.busy.rotate.action": "__play_guidance",
      "dp.fwd.busy.hangup.action": "__play_guidance",
      "dp.fwd.noanswer.rotate.action": "__play_guidance",
      "dp.fwd.noanswer.hangup.action": "__play_guidance",
      "dp.fwd.unavailable.rotate.action": "__play_guidance",
      "dp.fwd.unavailable.hangup.action": "__play_guidance",
      "dp.fwd.answered.prepare.whispering": true,
      "dp.fwd.answered.prepare.playfile": "1234567890abcdef12345678_voice",
      "dp.fwd.answered.leg2discon.action": "__play_guidance",
      "dp.fwd.answered.hangup.action": "__email_notify_noguidance",
      "dp.fwd.call_rotate.enable": true,
      "dp.fwd.call_rotate.phone": [
        "09012345678",
        "07098765432"
      ],
      "dp.shutdown.action": "__email_notify_noguidance",
      "dp.email.enable": false,
      "dp.email.to": [
        "sample@comsq.com"
      ],
      "dp.http.enable": false,
      "dp.fwd.altphone": "0399999999",
      "dp.vars": {
        "anykey1": "anykey1",
        "anykey2": "anykey2"
      },
      "clientID": "clientA",
      "viewname": "広告主A",
      "dp.phone": "09012345678",
      "dp.forward_enable": true,
      "tags": [
        "test1",
        "test2"
      ],
      "agency": "567856785678567856785678",
      "_id": "571f22f065a298a60a20ab69"
    }
  ],
  "trn_id": "570315a53e3f8b166d12945c",
  "trn_tms": "2015-06-25T18:17:24+09:00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "dp.talkrec.enable": {
            "type": "boolean",
            "description": "通話録音を有効にする際にtrueを設定します。"
          },
          "dp.deny.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__donothing"
            ],
            "description": "転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。"
          },
          "dp.absence.action": {
            "type": "string",
            "enum": [
              "__play_guidance_exit",
              "__change_fwd",
              "__hangup",
              "__email_notify_exit",
              "__http_notify_exit",
              "__donothing"
            ],
            "description": "不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。"
          },
          "dp.absence.enable": {
            "type": "boolean",
            "description": "不在設定のON・OFFを設定します。true→不在、false→在席。"
          },
          "dp.recycle.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "リサイクル期間に動作するアクション名を指定します。"
          },
          "dp.disturb.anonymous.allow": {
            "type": "boolean",
            "description": "非通知からの着信拒否を設定します。true→非通知を許可、false→非通知を拒否。"
          },
          "dp.disturb.anonymous.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__donothing"
            ],
            "description": "非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。"
          },
          "dp.fwd.dialing.callingsec": {
            "type": "number",
            "description": "転送先を呼び出す秒数を指定します。指定した秒数を超えると「無応答」と判断されます。"
          },
          "dp.preforward.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__http_notify",
              "__donothing"
            ],
            "description": "呼び出し前に動作するアクション名を指定します。"
          },
          "dp.fwd.dialing.action": {
            "type": "string",
            "enum": [
              "ring",
              "moh",
              "talkie"
            ],
            "description": "呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）"
          },
          "dp.fwd.dialing.playfile": {
            "type": "string",
            "description": "dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。"
          },
          "dp.fwd.cancel.hangup.action": {
            "type": "string",
            "enum": [
              "__email_notify_noguidance",
              "__http_notify_noguidance",
              "__donothing"
            ],
            "description": "転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。"
          },
          "dp.fwd.busy.rotate.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。"
          },
          "dp.fwd.busy.hangup.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。"
          },
          "dp.fwd.noanswer.rotate.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。"
          },
          "dp.fwd.noanswer.hangup.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。"
          },
          "dp.fwd.unavailable.rotate.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。"
          },
          "dp.fwd.unavailable.hangup.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。"
          },
          "dp.fwd.answered.prepare.whispering": {
            "type": "boolean",
            "description": "転送先応答時、入電ガイダンスを再生するときにtrueを指定します。"
          },
          "dp.fwd.answered.prepare.playfile": {
            "type": "string",
            "description": "入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。"
          },
          "dp.fwd.answered.leg2discon.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__donothing"
            ],
            "description": "通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。"
          },
          "dp.fwd.answered.hangup.action": {
            "type": "string",
            "enum": [
              "__email_notify_noguidance",
              "__http_notify_noguidance",
              "__donothing"
            ],
            "description": "通話が成立した際、通話終了時に動作するアクション名を指定します。"
          },
          "dp.fwd.call_rotate.enable": {
            "type": "boolean",
            "description": "順次転送機能を有効にする際にtrueに設定します。"
          },
          "dp.fwd.call_rotate.phone": {
            "type": "array",
            "items": [
              {
                "type": "string"
              },
              {
                "type": "string"
              }
            ],
            "description": "順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。"
          },
          "dp.shutdown.action": {
            "type": "string",
            "enum": [
              "__email_notify_noguidance",
              "__http_notify_noguidance",
              "__donothing"
            ],
            "description": "通話終了時に動作するアクション名を指定します。"
          },
          "dp.email.enable": {
            "type": "boolean",
            "description": "メール通知設定を有効にする際に、trueを指定します。"
          },
          "dp.email.to": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。"
          },
          "dp.http.enable": {
            "type": "boolean",
            "description": "Webプッシュ通知設定を有効にする際に、trueを指定します。"
          },
          "dp.fwd.altphone": {
            "type": "string",
            "description": "転送先変更（__change_fwd）設定時の電話番号を指定します。"
          },
          "dp.vars": {
            "type": "object",
            "properties": {
              "anykey1": {
                "type": "string"
              },
              "anykey2": {
                "type": "string"
              }
            },
            "description": "任意のkey-valueを設定できます。"
          },
          "clientID": {
            "type": "string",
            "description": "広告主ID。事業者様にて管理している一意なID。半角英数字、および、-_.@:で、1文字以上指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。"
          },
          "viewname": {
            "type": "string",
            "description": "管理画面や通話ログに出力する広告主の名称。"
          },
          "dp.phone": {
            "type": "string",
            "description": "転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。"
          },
          "dp.forward_enable": {
            "type": "boolean",
            "description": "転送可否。"
          },
          "tags": {
            "type": "array",
            "items": [
              {
                "type": "string"
              },
              {
                "type": "string"
              }
            ],
            "description": "広告主に定義するタグを配列で指定します。"
          },
          "agency": {
            "type": "string",
            "description": "代理店のシステム管理ID。"
          },
          "_id": {
            "type": "string",
            "description": "システム管理ID。"
          }
        },
        "required": [
          "dp.phone",
          "dp.forward_enable",
          "_id"
        ]
      }
    },
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "trn_tms": {
      "type": "string",
      "description": "処理成功日時。"
    }
  },
  "required": [
    "result",
    "trn_id",
    "trn_tms"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

広告主情報一覧取得
GET`/clients/{partner}`

広告主情報を取得します。
要求を受け付けると、URLパラメータで指定された事業者の情報を全て応答します。

URI Parameters

HideShow

partner: string (required) Example: 12345678901234567890abcd
事業者ID

広告主情報一件取得 ¶

GET https://api.calltracker.jp/ct/3.0a/clients/12345678901234567890abcd/999999999999999999999999

Responses200400401403404406409500

Headers

Content-Type: application/json

Body

{
  "result": [
    {
      "dp.talkrec.enable": true,
      "dp.deny.action": "__play_guidance",
      "dp.absence.action": "__play_guidance_exit",
      "dp.absence.enable": false,
      "dp.recycle.action": "__play_guidance",
      "dp.disturb.anonymous.allow": true,
      "dp.disturb.anonymous.action": "__play_guidance",
      "dp.fwd.dialing.callingsec": 30,
      "dp.preforward.action": "__play_guidance",
      "dp.fwd.dialing.action": "ring",
      "dp.fwd.dialing.playfile": "1234567890abcdef12345678_moh",
      "dp.fwd.cancel.hangup.action": "__email_notify_noguidance",
      "dp.fwd.busy.rotate.action": "__play_guidance",
      "dp.fwd.busy.hangup.action": "__play_guidance",
      "dp.fwd.noanswer.rotate.action": "__play_guidance",
      "dp.fwd.noanswer.hangup.action": "__play_guidance",
      "dp.fwd.unavailable.rotate.action": "__play_guidance",
      "dp.fwd.unavailable.hangup.action": "__play_guidance",
      "dp.fwd.answered.prepare.whispering": true,
      "dp.fwd.answered.prepare.playfile": "1234567890abcdef12345678_voice",
      "dp.fwd.answered.leg2discon.action": "__play_guidance",
      "dp.fwd.answered.hangup.action": "__email_notify_noguidance",
      "dp.fwd.call_rotate.enable": true,
      "dp.fwd.call_rotate.phone": [
        "09012345678",
        "07098765432"
      ],
      "dp.shutdown.action": "__email_notify_noguidance",
      "dp.email.enable": false,
      "dp.email.to": [
        "sample@comsq.com"
      ],
      "dp.http.enable": false,
      "dp.fwd.altphone": "0399999999",
      "dp.vars": {
        "anykey1": "anykey1",
        "anykey2": "anykey2"
      },
      "clientID": "clientA",
      "viewname": "広告主A",
      "dp.phone": "09012345678",
      "dp.forward_enable": true,
      "tags": [
        "test1",
        "test2"
      ],
      "agency": "567856785678567856785678",
      "_id": "571f22f065a298a60a20ab69"
    }
  ],
  "trn_id": "570315a53e3f8b166d12945c",
  "trn_tms": "2015-06-25T18:17:24+09:00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "dp.talkrec.enable": {
            "type": "boolean",
            "description": "通話録音を有効にする際にtrueを設定します。"
          },
          "dp.deny.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__donothing"
            ],
            "description": "転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。"
          },
          "dp.absence.action": {
            "type": "string",
            "enum": [
              "__play_guidance_exit",
              "__change_fwd",
              "__hangup",
              "__email_notify_exit",
              "__http_notify_exit",
              "__donothing"
            ],
            "description": "不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。"
          },
          "dp.absence.enable": {
            "type": "boolean",
            "description": "不在設定のON・OFFを設定します。true→不在、false→在席。"
          },
          "dp.recycle.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "リサイクル期間に動作するアクション名を指定します。"
          },
          "dp.disturb.anonymous.allow": {
            "type": "boolean",
            "description": "非通知からの着信拒否を設定します。true→非通知を許可、false→非通知を拒否。"
          },
          "dp.disturb.anonymous.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__donothing"
            ],
            "description": "非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。"
          },
          "dp.fwd.dialing.callingsec": {
            "type": "number",
            "description": "転送先を呼び出す秒数を指定します。指定した秒数を超えると「無応答」と判断されます。"
          },
          "dp.preforward.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__http_notify",
              "__donothing"
            ],
            "description": "呼び出し前に動作するアクション名を指定します。"
          },
          "dp.fwd.dialing.action": {
            "type": "string",
            "enum": [
              "ring",
              "moh",
              "talkie"
            ],
            "description": "呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）"
          },
          "dp.fwd.dialing.playfile": {
            "type": "string",
            "description": "dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。"
          },
          "dp.fwd.cancel.hangup.action": {
            "type": "string",
            "enum": [
              "__email_notify_noguidance",
              "__http_notify_noguidance",
              "__donothing"
            ],
            "description": "転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。"
          },
          "dp.fwd.busy.rotate.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。"
          },
          "dp.fwd.busy.hangup.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。"
          },
          "dp.fwd.noanswer.rotate.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。"
          },
          "dp.fwd.noanswer.hangup.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。"
          },
          "dp.fwd.unavailable.rotate.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。"
          },
          "dp.fwd.unavailable.hangup.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。"
          },
          "dp.fwd.answered.prepare.whispering": {
            "type": "boolean",
            "description": "転送先応答時、入電ガイダンスを再生するときにtrueを指定します。"
          },
          "dp.fwd.answered.prepare.playfile": {
            "type": "string",
            "description": "入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。"
          },
          "dp.fwd.answered.leg2discon.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__donothing"
            ],
            "description": "通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。"
          },
          "dp.fwd.answered.hangup.action": {
            "type": "string",
            "enum": [
              "__email_notify_noguidance",
              "__http_notify_noguidance",
              "__donothing"
            ],
            "description": "通話が成立した際、通話終了時に動作するアクション名を指定します。"
          },
          "dp.fwd.call_rotate.enable": {
            "type": "boolean",
            "description": "順次転送機能を有効にする際にtrueに設定します。"
          },
          "dp.fwd.call_rotate.phone": {
            "type": "array",
            "items": [
              {
                "type": "string"
              },
              {
                "type": "string"
              }
            ],
            "description": "順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。"
          },
          "dp.shutdown.action": {
            "type": "string",
            "enum": [
              "__email_notify_noguidance",
              "__http_notify_noguidance",
              "__donothing"
            ],
            "description": "通話終了時に動作するアクション名を指定します。"
          },
          "dp.email.enable": {
            "type": "boolean",
            "description": "メール通知設定を有効にする際に、trueを指定します。"
          },
          "dp.email.to": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。"
          },
          "dp.http.enable": {
            "type": "boolean",
            "description": "Webプッシュ通知設定を有効にする際に、trueを指定します。"
          },
          "dp.fwd.altphone": {
            "type": "string",
            "description": "転送先変更（__change_fwd）設定時の電話番号を指定します。"
          },
          "dp.vars": {
            "type": "object",
            "properties": {
              "anykey1": {
                "type": "string"
              },
              "anykey2": {
                "type": "string"
              }
            },
            "description": "任意のkey-valueを設定できます。"
          },
          "clientID": {
            "type": "string",
            "description": "広告主ID。事業者様にて管理している一意なID。半角英数字、および、-_.@:で、1文字以上指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。"
          },
          "viewname": {
            "type": "string",
            "description": "管理画面や通話ログに出力する広告主の名称。"
          },
          "dp.phone": {
            "type": "string",
            "description": "転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。"
          },
          "dp.forward_enable": {
            "type": "boolean",
            "description": "転送可否。"
          },
          "tags": {
            "type": "array",
            "items": [
              {
                "type": "string"
              },
              {
                "type": "string"
              }
            ],
            "description": "広告主に定義するタグを配列で指定します。"
          },
          "agency": {
            "type": "string",
            "description": "代理店のシステム管理ID。"
          },
          "_id": {
            "type": "string",
            "description": "システム管理ID。"
          }
        },
        "required": [
          "dp.phone",
          "dp.forward_enable",
          "_id"
        ]
      }
    },
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "trn_tms": {
      "type": "string",
      "description": "処理成功日時。"
    }
  },
  "required": [
    "result",
    "trn_id",
    "trn_tms"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

広告主情報一件取得
GET`/clients/{partner}/{client}`

広告主情報を取得します。
要求を受け付けると、URLパラメータで指定された広告主の情報を応答します。

URI Parameters

HideShow

partner: string (required) Example: 12345678901234567890abcd
事業者ID
client: string (required) Example: 999999999999999999999999
広告主のシステム管理ID

番号管理 ¶

トラッキング番号の発番・編集・削除・取得を行います。

トラッキング番号発番 ¶

POST https://api.calltracker.jp/ct/3.0a/dialins/demand/12345678901234567890abcd/999999999999999999999999

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "dp.talkrec.enable": true,
  "dp.deny.action": "__play_guidance",
  "dp.absence.action": "__play_guidance_exit",
  "dp.absence.enable": false,
  "dp.recycle.action": "__play_guidance",
  "dp.disturb.anonymous.allow": true,
  "dp.disturb.anonymous.action": "__play_guidance",
  "dp.fwd.dialing.callingsec": 30,
  "dp.preforward.action": "__play_guidance",
  "dp.fwd.dialing.action": "ring",
  "dp.fwd.dialing.playfile": "1234567890abcdef12345678_moh",
  "dp.fwd.cancel.hangup.action": "__email_notify_noguidance",
  "dp.fwd.busy.rotate.action": "__play_guidance",
  "dp.fwd.busy.hangup.action": "__play_guidance",
  "dp.fwd.noanswer.rotate.action": "__play_guidance",
  "dp.fwd.noanswer.hangup.action": "__play_guidance",
  "dp.fwd.unavailable.rotate.action": "__play_guidance",
  "dp.fwd.unavailable.hangup.action": "__play_guidance",
  "dp.fwd.answered.prepare.whispering": true,
  "dp.fwd.answered.prepare.playfile": "1234567890abcdef12345678_voice",
  "dp.fwd.answered.leg2discon.action": "__play_guidance",
  "dp.fwd.answered.hangup.action": "__email_notify_noguidance",
  "dp.fwd.call_rotate.enable": true,
  "dp.fwd.call_rotate.phone": [
    "09012345678",
    "07098765432"
  ],
  "dp.shutdown.action": "__email_notify_noguidance",
  "dp.email.enable": false,
  "dp.email.to": [
    "sample@comsq.com"
  ],
  "dp.http.enable": false,
  "dp.fwd.altphone": "0399999999",
  "dp.vars": {
    "anykey1": "anykey1",
    "anykey2": "anykey2"
  },
  "valid_from": "2015-06-25T18:17:24+09:00",
  "valid_until": "2015-06-25T18:17:24+09:00",
  "_exp_at": "2015-06-25T18:17:24+09:00",
  "dialinID": "dialinA",
  "viewname": "番号A",
  "dp.phone": "09012345678",
  "dp.forward_enable": true,
  "tags": [
    "test1",
    "test2"
  ],
  "demand_key": "demand050"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "dp.talkrec.enable": {
      "type": "boolean",
      "description": "通話録音を有効にする際にtrueを設定します。"
    },
    "dp.deny.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__donothing"
      ],
      "description": "転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。"
    },
    "dp.absence.action": {
      "type": "string",
      "enum": [
        "__play_guidance_exit",
        "__change_fwd",
        "__hangup",
        "__email_notify_exit",
        "__http_notify_exit",
        "__donothing"
      ],
      "description": "不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。"
    },
    "dp.absence.enable": {
      "type": "boolean",
      "description": "不在設定のON・OFFを設定します。true→不在、false→在席。"
    },
    "dp.recycle.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "リサイクル期間に動作するアクション名を指定します。"
    },
    "dp.disturb.anonymous.allow": {
      "type": "boolean",
      "description": "非通知からの着信拒否を設定します。true→非通知を許可、false→非通知を拒否。"
    },
    "dp.disturb.anonymous.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__donothing"
      ],
      "description": "非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。"
    },
    "dp.fwd.dialing.callingsec": {
      "type": "number",
      "description": "転送先を呼び出す秒数を指定します。指定した秒数を超えると「無応答」と判断されます。"
    },
    "dp.preforward.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__http_notify",
        "__donothing"
      ],
      "description": "呼び出し前に動作するアクション名を指定します。"
    },
    "dp.fwd.dialing.action": {
      "type": "string",
      "enum": [
        "ring",
        "moh",
        "talkie"
      ],
      "description": "呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）"
    },
    "dp.fwd.dialing.playfile": {
      "type": "string",
      "description": "dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。"
    },
    "dp.fwd.cancel.hangup.action": {
      "type": "string",
      "enum": [
        "__email_notify_noguidance",
        "__http_notify_noguidance",
        "__donothing"
      ],
      "description": "転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。"
    },
    "dp.fwd.busy.rotate.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。"
    },
    "dp.fwd.busy.hangup.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。"
    },
    "dp.fwd.noanswer.rotate.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。"
    },
    "dp.fwd.noanswer.hangup.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。"
    },
    "dp.fwd.unavailable.rotate.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。"
    },
    "dp.fwd.unavailable.hangup.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。"
    },
    "dp.fwd.answered.prepare.whispering": {
      "type": "boolean",
      "description": "転送先応答時、入電ガイダンスを再生するときにtrueを指定します。"
    },
    "dp.fwd.answered.prepare.playfile": {
      "type": "string",
      "description": "入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。"
    },
    "dp.fwd.answered.leg2discon.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__donothing"
      ],
      "description": "通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。"
    },
    "dp.fwd.answered.hangup.action": {
      "type": "string",
      "enum": [
        "__email_notify_noguidance",
        "__http_notify_noguidance",
        "__donothing"
      ],
      "description": "通話が成立した際、通話終了時に動作するアクション名を指定します。"
    },
    "dp.fwd.call_rotate.enable": {
      "type": "boolean",
      "description": "順次転送機能を有効にする際にtrueに設定します。"
    },
    "dp.fwd.call_rotate.phone": {
      "type": "array",
      "items": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。"
    },
    "dp.shutdown.action": {
      "type": "string",
      "enum": [
        "__email_notify_noguidance",
        "__http_notify_noguidance",
        "__donothing"
      ],
      "description": "通話終了時に動作するアクション名を指定します。"
    },
    "dp.email.enable": {
      "type": "boolean",
      "description": "メール通知設定を有効にする際に、trueを指定します。"
    },
    "dp.email.to": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。"
    },
    "dp.http.enable": {
      "type": "boolean",
      "description": "Webプッシュ通知設定を有効にする際に、trueを指定します。"
    },
    "dp.fwd.altphone": {
      "type": "string",
      "description": "転送先変更（__change_fwd）設定時の電話番号を指定します。"
    },
    "dp.vars": {
      "type": "object",
      "properties": {
        "anykey1": {
          "type": "string"
        },
        "anykey2": {
          "type": "string"
        }
      },
      "description": "任意のkey-valueを設定できます。"
    },
    "valid_from": {
      "type": "string",
      "description": "転送を開始する日時。日付の形式で指定してください。指定が無ければ、現在日時で設定します。"
    },
    "valid_until": {
      "type": "string",
      "description": "転送を終了する日時。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。"
    },
    "_exp_at": {
      "type": "string",
      "description": "番号の有効期限。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。有効期限を過ぎると、自動的に番号在庫に戻ります。"
    },
    "dialinID": {
      "type": "string",
      "description": "番号ID。事業者様にて管理している一意なID。任意で設定が可能ですが、全番号を通してユニークな値である必要があります。半角英数字、および、-_.@:を1文字以上で指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。"
    },
    "viewname": {
      "type": "string",
      "description": "管理画面や通話ログに出力する番号の名称。"
    },
    "dp.phone": {
      "type": "string",
      "description": "転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。（広告主の情報を上書きして、異なる番号に転送する場合にのみ指定します。）"
    },
    "dp.forward_enable": {
      "type": "boolean",
      "description": "転送可否。"
    },
    "tags": {
      "type": "array",
      "items": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "トラッキング番号に定義するタグを配列で指定します。"
    },
    "demand_key": {
      "type": "string",
      "description": "発番キー。番号帯（050や0066）別に事前にコムスクエアから発行されます。"
    }
  },
  "required": [
    "demand_key"
  ]
}

Responses200400401403404406409500

Headers

Content-Type: application/json

Body

{
  "result": {
    "dp.talkrec.enable": true,
    "dp.deny.action": "__play_guidance",
    "dp.absence.action": "__play_guidance_exit",
    "dp.absence.enable": false,
    "dp.recycle.action": "__play_guidance",
    "dp.disturb.anonymous.allow": true,
    "dp.disturb.anonymous.action": "__play_guidance",
    "dp.fwd.dialing.callingsec": 30,
    "dp.preforward.action": "__play_guidance",
    "dp.fwd.dialing.action": "ring",
    "dp.fwd.dialing.playfile": "1234567890abcdef12345678_moh",
    "dp.fwd.cancel.hangup.action": "__email_notify_noguidance",
    "dp.fwd.busy.rotate.action": "__play_guidance",
    "dp.fwd.busy.hangup.action": "__play_guidance",
    "dp.fwd.noanswer.rotate.action": "__play_guidance",
    "dp.fwd.noanswer.hangup.action": "__play_guidance",
    "dp.fwd.unavailable.rotate.action": "__play_guidance",
    "dp.fwd.unavailable.hangup.action": "__play_guidance",
    "dp.fwd.answered.prepare.whispering": true,
    "dp.fwd.answered.prepare.playfile": "1234567890abcdef12345678_voice",
    "dp.fwd.answered.leg2discon.action": "__play_guidance",
    "dp.fwd.answered.hangup.action": "__email_notify_noguidance",
    "dp.fwd.call_rotate.enable": true,
    "dp.fwd.call_rotate.phone": [
      "09012345678",
      "07098765432"
    ],
    "dp.shutdown.action": "__email_notify_noguidance",
    "dp.email.enable": false,
    "dp.email.to": [
      "sample@comsq.com"
    ],
    "dp.http.enable": false,
    "dp.fwd.altphone": "0399999999",
    "dp.vars": {
      "anykey1": "anykey1",
      "anykey2": "anykey2"
    },
    "valid_from": "2015-06-25T18:17:24+09:00",
    "valid_until": "2015-06-25T18:17:24+09:00",
    "_exp_at": "2015-06-25T18:17:24+09:00",
    "dialinID": "dialinA",
    "viewname": "番号A",
    "dp.phone": "09012345678",
    "dp.forward_enable": true,
    "tags": [
      "test1",
      "test2"
    ],
    "_id": "501234567800000000000000",
    "ct_phone": "05012345678"
  },
  "trn_id": "570315a53e3f8b166d12945c",
  "trn_tms": "2015-06-25T18:17:24+09:00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "result": {
      "type": "object",
      "properties": {
        "dp.talkrec.enable": {
          "type": "boolean",
          "description": "通話録音を有効にする際にtrueを設定します。"
        },
        "dp.deny.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。"
        },
        "dp.absence.action": {
          "type": "string",
          "enum": [
            "__play_guidance_exit",
            "__change_fwd",
            "__hangup",
            "__email_notify_exit",
            "__http_notify_exit",
            "__donothing"
          ],
          "description": "不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。"
        },
        "dp.absence.enable": {
          "type": "boolean",
          "description": "不在設定のON・OFFを設定します。true→不在、false→在席。"
        },
        "dp.recycle.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "リサイクル期間に動作するアクション名を指定します。"
        },
        "dp.disturb.anonymous.allow": {
          "type": "boolean",
          "description": "非通知からの着信拒否を設定します。true→非通知を許可、false→非通知を拒否。"
        },
        "dp.disturb.anonymous.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。"
        },
        "dp.fwd.dialing.callingsec": {
          "type": "number",
          "description": "転送先を呼び出す秒数を指定します。指定した秒数を超えると「無応答」と判断されます。"
        },
        "dp.preforward.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__http_notify",
            "__donothing"
          ],
          "description": "呼び出し前に動作するアクション名を指定します。"
        },
        "dp.fwd.dialing.action": {
          "type": "string",
          "enum": [
            "ring",
            "moh",
            "talkie"
          ],
          "description": "呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）"
        },
        "dp.fwd.dialing.playfile": {
          "type": "string",
          "description": "dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。"
        },
        "dp.fwd.cancel.hangup.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。"
        },
        "dp.fwd.busy.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.busy.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.noanswer.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.noanswer.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.unavailable.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.unavailable.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.answered.prepare.whispering": {
          "type": "boolean",
          "description": "転送先応答時、入電ガイダンスを再生するときにtrueを指定します。"
        },
        "dp.fwd.answered.prepare.playfile": {
          "type": "string",
          "description": "入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。"
        },
        "dp.fwd.answered.leg2discon.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。"
        },
        "dp.fwd.answered.hangup.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "通話が成立した際、通話終了時に動作するアクション名を指定します。"
        },
        "dp.fwd.call_rotate.enable": {
          "type": "boolean",
          "description": "順次転送機能を有効にする際にtrueに設定します。"
        },
        "dp.fwd.call_rotate.phone": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ],
          "description": "順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。"
        },
        "dp.shutdown.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "通話終了時に動作するアクション名を指定します。"
        },
        "dp.email.enable": {
          "type": "boolean",
          "description": "メール通知設定を有効にする際に、trueを指定します。"
        },
        "dp.email.to": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。"
        },
        "dp.http.enable": {
          "type": "boolean",
          "description": "Webプッシュ通知設定を有効にする際に、trueを指定します。"
        },
        "dp.fwd.altphone": {
          "type": "string",
          "description": "転送先変更（__change_fwd）設定時の電話番号を指定します。"
        },
        "dp.vars": {
          "type": "object",
          "properties": {
            "anykey1": {
              "type": "string"
            },
            "anykey2": {
              "type": "string"
            }
          },
          "description": "任意のkey-valueを設定できます。"
        },
        "valid_from": {
          "type": "string",
          "description": "転送を開始する日時。日付の形式で指定してください。指定が無ければ、現在日時で設定します。"
        },
        "valid_until": {
          "type": "string",
          "description": "転送を終了する日時。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。"
        },
        "_exp_at": {
          "type": "string",
          "description": "番号の有効期限。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。有効期限を過ぎると、自動的に番号在庫に戻ります。"
        },
        "dialinID": {
          "type": "string",
          "description": "番号ID。事業者様にて管理している一意なID。任意で設定が可能ですが、全番号を通してユニークな値である必要があります。半角英数字、および、-_.@:を1文字以上で指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。"
        },
        "viewname": {
          "type": "string",
          "description": "管理画面や通話ログに出力する番号の名称。"
        },
        "dp.phone": {
          "type": "string",
          "description": "転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。（広告主の情報を上書きして、異なる番号に転送する場合にのみ指定します。）"
        },
        "dp.forward_enable": {
          "type": "boolean",
          "description": "転送可否。"
        },
        "tags": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ],
          "description": "トラッキング番号に定義するタグを配列で指定します。"
        },
        "_id": {
          "type": "string",
          "description": "システム管理ID。"
        },
        "ct_phone": {
          "type": "string",
          "description": "トラッキング番号。"
        }
      },
      "required": [
        "_id",
        "ct_phone"
      ],
      "description": "APIの実行結果。"
    },
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "trn_tms": {
      "type": "string",
      "description": "処理成功日時。"
    }
  },
  "required": [
    "result",
    "trn_id",
    "trn_tms"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

トラッキング番号発番
POST`/dialins/demand/{partner}/{client}`

トラッキング番号の発番を行います。
事前にコムスクエアより発行された発番キーを指定して発番します。
要求を受け付けると、番号在庫の中から利用していない、トラッキング番号を発行し、応答します。
リクエストボディ中に番号情報に関するパラメータと電話の動作に関するパラメータを指定してリクエストします。パラメータは以下の通りです。
パラメータの値にnullを指定した場合は、そのパラメータの値にnullが登録されます。

要素名	データ型	必須	説明
demand_key	string	required	発番キー。番号帯（050や0066）別に事前にコムスクエアから発行されます。
valid_from	string	optional	転送を開始する日時。日付の形式で指定してください。指定が無ければ、現在日時で設定します。
valid_until	string	optional	転送を終了する日時。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。
_exp_at	string	optional	番号の有効期限。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。有効期限を過ぎると、自動的に番号在庫に戻ります。
dialinID	string	optional	番号ID。事業者様にて管理している一意なID。任意で設定が可能ですが、全番号を通してユニークな値である必要があります。半角英数字、および、-_.@:を1文字以上で指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。
viewname	string	optional	管理画面や通話ログに出力する番号の名称。
dp.phone	string	optional	転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。（広告主の情報を上書きして、異なる番号に転送する場合にのみ指定します。）
dp.forward_enable	boolean	optional	転送可否。trueが転送する、falseが転送しない、を表します。
tags	array:string	optional	番号に付けるタグを指定。複数指定することができます。

要素名	データ型	必須	説明
dp.talkrec.enable	boolean	optional	通話録音を有効にする際にtrueを設定します。
dp.deny.action	enum	optional	転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.absence.action	enum	optional	不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。有償オプションのため、ご利用には事前に申請が必要となります。
dp.absence.enable	boolean	optional	不在設定のON・OFFを設定します。trueが不在、falseが在席を表します。有償オプションのため、ご利用には事前に申請が必要となります。
dp.recycle.action	enum	optional	リサイクル期間に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.disturb.anonymous.allow	boolean	optional	非通知からの着信拒否を設定します。trueが非通知を許可、falseが非通知を拒否する設定を表します。
dp.disturb.anonymous.action	enum	optional	非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.preforward.action	enum	optional	呼び出し前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.dialing.action	enum	optional	呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）
dp.fwd.dialing.playfile	string	optional	dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。
dp.fwd.cancel.hangup.action	enum	optional	転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.busy.rotate.action	enum	optional	順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.busy.hangup.action	enum	optional	転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.noanswer.rotate.action	enum	optional	順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.noanswer.hangup.action	enum	optional	転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.unavailable.rotate.action	enum	optional	順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.unavailable.hangup.action	enum	optional	転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.answered.prepare.whispering	boolean	optional	転送先応答時、入電ガイダンスを再生するときにtrueを指定します。
dp.fwd.answered.prepare.playfile	string	optional	入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。
dp.fwd.answered.leg2discon.action	enum	optional	通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.answered.hangup.action	enum	optional	通話が成立した際、通話終了時に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.call_rotate.enable	boolean	optional	順次転送機能を有効にする際にtrueに設定します。
dp.fwd.call_rotate.phone	array:string	optional	順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。
dp.shutdown.action	enum	optional	通話終了時に動作するアクション名を指定します。
dp.email.enable	boolean	optional	メール通知設定を有効にする際に、trueを指定します。
dp.email.to	array:string	optional	メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。
dp.http.enable	boolean	optional	Webプッシュ通知設定を有効にする際に、trueを指定します。
dp.fwd.altphone	string	optional	転送先変更（__change_fwd）設定時の電話番号を指定します。
dp.vars	object	optional	任意のkey-valueを設定できます。

URI Parameters

HideShow

partner: string (required) Example: 12345678901234567890abcd
事業者ID
client: string (required) Example: 999999999999999999999999
広告主のシステム管理ID

トラッキング番号発番（番号指定） ¶

POST https://api.calltracker.jp/ct/3.0a/dialins/12345678901234567890abcd/999999999999999999999999

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "dp.talkrec.enable": true,
  "dp.deny.action": "__play_guidance",
  "dp.absence.action": "__play_guidance_exit",
  "dp.absence.enable": false,
  "dp.recycle.action": "__play_guidance",
  "dp.disturb.anonymous.allow": true,
  "dp.disturb.anonymous.action": "__play_guidance",
  "dp.fwd.dialing.callingsec": 30,
  "dp.preforward.action": "__play_guidance",
  "dp.fwd.dialing.action": "ring",
  "dp.fwd.dialing.playfile": "1234567890abcdef12345678_moh",
  "dp.fwd.cancel.hangup.action": "__email_notify_noguidance",
  "dp.fwd.busy.rotate.action": "__play_guidance",
  "dp.fwd.busy.hangup.action": "__play_guidance",
  "dp.fwd.noanswer.rotate.action": "__play_guidance",
  "dp.fwd.noanswer.hangup.action": "__play_guidance",
  "dp.fwd.unavailable.rotate.action": "__play_guidance",
  "dp.fwd.unavailable.hangup.action": "__play_guidance",
  "dp.fwd.answered.prepare.whispering": true,
  "dp.fwd.answered.prepare.playfile": "1234567890abcdef12345678_voice",
  "dp.fwd.answered.leg2discon.action": "__play_guidance",
  "dp.fwd.answered.hangup.action": "__email_notify_noguidance",
  "dp.fwd.call_rotate.enable": true,
  "dp.fwd.call_rotate.phone": [
    "09012345678",
    "07098765432"
  ],
  "dp.shutdown.action": "__email_notify_noguidance",
  "dp.email.enable": false,
  "dp.email.to": [
    "sample@comsq.com"
  ],
  "dp.http.enable": false,
  "dp.fwd.altphone": "0399999999",
  "dp.vars": {
    "anykey1": "anykey1",
    "anykey2": "anykey2"
  },
  "valid_from": "2015-06-25T18:17:24+09:00",
  "valid_until": "2015-06-25T18:17:24+09:00",
  "_exp_at": "2015-06-25T18:17:24+09:00",
  "dialinID": "dialinA",
  "viewname": "番号A",
  "dp.phone": "09012345678",
  "dp.forward_enable": true,
  "tags": [
    "test1",
    "test2"
  ],
  "ct_phone": "05012345678"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "dp.talkrec.enable": {
      "type": "boolean",
      "description": "通話録音を有効にする際にtrueを設定します。"
    },
    "dp.deny.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__donothing"
      ],
      "description": "転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。"
    },
    "dp.absence.action": {
      "type": "string",
      "enum": [
        "__play_guidance_exit",
        "__change_fwd",
        "__hangup",
        "__email_notify_exit",
        "__http_notify_exit",
        "__donothing"
      ],
      "description": "不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。"
    },
    "dp.absence.enable": {
      "type": "boolean",
      "description": "不在設定のON・OFFを設定します。true→不在、false→在席。"
    },
    "dp.recycle.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "リサイクル期間に動作するアクション名を指定します。"
    },
    "dp.disturb.anonymous.allow": {
      "type": "boolean",
      "description": "非通知からの着信拒否を設定します。true→非通知を許可、false→非通知を拒否。"
    },
    "dp.disturb.anonymous.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__donothing"
      ],
      "description": "非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。"
    },
    "dp.fwd.dialing.callingsec": {
      "type": "number",
      "description": "転送先を呼び出す秒数を指定します。指定した秒数を超えると「無応答」と判断されます。"
    },
    "dp.preforward.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__http_notify",
        "__donothing"
      ],
      "description": "呼び出し前に動作するアクション名を指定します。"
    },
    "dp.fwd.dialing.action": {
      "type": "string",
      "enum": [
        "ring",
        "moh",
        "talkie"
      ],
      "description": "呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）"
    },
    "dp.fwd.dialing.playfile": {
      "type": "string",
      "description": "dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。"
    },
    "dp.fwd.cancel.hangup.action": {
      "type": "string",
      "enum": [
        "__email_notify_noguidance",
        "__http_notify_noguidance",
        "__donothing"
      ],
      "description": "転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。"
    },
    "dp.fwd.busy.rotate.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。"
    },
    "dp.fwd.busy.hangup.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。"
    },
    "dp.fwd.noanswer.rotate.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。"
    },
    "dp.fwd.noanswer.hangup.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。"
    },
    "dp.fwd.unavailable.rotate.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。"
    },
    "dp.fwd.unavailable.hangup.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。"
    },
    "dp.fwd.answered.prepare.whispering": {
      "type": "boolean",
      "description": "転送先応答時、入電ガイダンスを再生するときにtrueを指定します。"
    },
    "dp.fwd.answered.prepare.playfile": {
      "type": "string",
      "description": "入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。"
    },
    "dp.fwd.answered.leg2discon.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__donothing"
      ],
      "description": "通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。"
    },
    "dp.fwd.answered.hangup.action": {
      "type": "string",
      "enum": [
        "__email_notify_noguidance",
        "__http_notify_noguidance",
        "__donothing"
      ],
      "description": "通話が成立した際、通話終了時に動作するアクション名を指定します。"
    },
    "dp.fwd.call_rotate.enable": {
      "type": "boolean",
      "description": "順次転送機能を有効にする際にtrueに設定します。"
    },
    "dp.fwd.call_rotate.phone": {
      "type": "array",
      "items": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。"
    },
    "dp.shutdown.action": {
      "type": "string",
      "enum": [
        "__email_notify_noguidance",
        "__http_notify_noguidance",
        "__donothing"
      ],
      "description": "通話終了時に動作するアクション名を指定します。"
    },
    "dp.email.enable": {
      "type": "boolean",
      "description": "メール通知設定を有効にする際に、trueを指定します。"
    },
    "dp.email.to": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。"
    },
    "dp.http.enable": {
      "type": "boolean",
      "description": "Webプッシュ通知設定を有効にする際に、trueを指定します。"
    },
    "dp.fwd.altphone": {
      "type": "string",
      "description": "転送先変更（__change_fwd）設定時の電話番号を指定します。"
    },
    "dp.vars": {
      "type": "object",
      "properties": {
        "anykey1": {
          "type": "string"
        },
        "anykey2": {
          "type": "string"
        }
      },
      "description": "任意のkey-valueを設定できます。"
    },
    "valid_from": {
      "type": "string",
      "description": "転送を開始する日時。日付の形式で指定してください。指定が無ければ、現在日時で設定します。"
    },
    "valid_until": {
      "type": "string",
      "description": "転送を終了する日時。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。"
    },
    "_exp_at": {
      "type": "string",
      "description": "番号の有効期限。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。有効期限を過ぎると、自動的に番号在庫に戻ります。"
    },
    "dialinID": {
      "type": "string",
      "description": "番号ID。事業者様にて管理している一意なID。任意で設定が可能ですが、全番号を通してユニークな値である必要があります。半角英数字、および、-_.@:を1文字以上で指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。"
    },
    "viewname": {
      "type": "string",
      "description": "管理画面や通話ログに出力する番号の名称。"
    },
    "dp.phone": {
      "type": "string",
      "description": "転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。（広告主の情報を上書きして、異なる番号に転送する場合にのみ指定します。）"
    },
    "dp.forward_enable": {
      "type": "boolean",
      "description": "転送可否。"
    },
    "tags": {
      "type": "array",
      "items": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "トラッキング番号に定義するタグを配列で指定します。"
    },
    "ct_phone": {
      "type": "string",
      "description": "トラッキング番号。電話番号の形式で指定されていない場合はエラーとなります。"
    }
  },
  "required": [
    "ct_phone"
  ]
}

Responses200400401403404406409500

Headers

Content-Type: application/json

Body

{
  "result": {
    "dp.talkrec.enable": true,
    "dp.deny.action": "__play_guidance",
    "dp.absence.action": "__play_guidance_exit",
    "dp.absence.enable": false,
    "dp.recycle.action": "__play_guidance",
    "dp.disturb.anonymous.allow": true,
    "dp.disturb.anonymous.action": "__play_guidance",
    "dp.fwd.dialing.callingsec": 30,
    "dp.preforward.action": "__play_guidance",
    "dp.fwd.dialing.action": "ring",
    "dp.fwd.dialing.playfile": "1234567890abcdef12345678_moh",
    "dp.fwd.cancel.hangup.action": "__email_notify_noguidance",
    "dp.fwd.busy.rotate.action": "__play_guidance",
    "dp.fwd.busy.hangup.action": "__play_guidance",
    "dp.fwd.noanswer.rotate.action": "__play_guidance",
    "dp.fwd.noanswer.hangup.action": "__play_guidance",
    "dp.fwd.unavailable.rotate.action": "__play_guidance",
    "dp.fwd.unavailable.hangup.action": "__play_guidance",
    "dp.fwd.answered.prepare.whispering": true,
    "dp.fwd.answered.prepare.playfile": "1234567890abcdef12345678_voice",
    "dp.fwd.answered.leg2discon.action": "__play_guidance",
    "dp.fwd.answered.hangup.action": "__email_notify_noguidance",
    "dp.fwd.call_rotate.enable": true,
    "dp.fwd.call_rotate.phone": [
      "09012345678",
      "07098765432"
    ],
    "dp.shutdown.action": "__email_notify_noguidance",
    "dp.email.enable": false,
    "dp.email.to": [
      "sample@comsq.com"
    ],
    "dp.http.enable": false,
    "dp.fwd.altphone": "0399999999",
    "dp.vars": {
      "anykey1": "anykey1",
      "anykey2": "anykey2"
    },
    "valid_from": "2015-06-25T18:17:24+09:00",
    "valid_until": "2015-06-25T18:17:24+09:00",
    "_exp_at": "2015-06-25T18:17:24+09:00",
    "dialinID": "dialinA",
    "viewname": "番号A",
    "dp.phone": "09012345678",
    "dp.forward_enable": true,
    "tags": [
      "test1",
      "test2"
    ],
    "_id": "501234567800000000000000",
    "ct_phone": "05012345678"
  },
  "trn_id": "570315a53e3f8b166d12945c",
  "trn_tms": "2015-06-25T18:17:24+09:00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "result": {
      "type": "object",
      "properties": {
        "dp.talkrec.enable": {
          "type": "boolean",
          "description": "通話録音を有効にする際にtrueを設定します。"
        },
        "dp.deny.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。"
        },
        "dp.absence.action": {
          "type": "string",
          "enum": [
            "__play_guidance_exit",
            "__change_fwd",
            "__hangup",
            "__email_notify_exit",
            "__http_notify_exit",
            "__donothing"
          ],
          "description": "不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。"
        },
        "dp.absence.enable": {
          "type": "boolean",
          "description": "不在設定のON・OFFを設定します。true→不在、false→在席。"
        },
        "dp.recycle.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "リサイクル期間に動作するアクション名を指定します。"
        },
        "dp.disturb.anonymous.allow": {
          "type": "boolean",
          "description": "非通知からの着信拒否を設定します。true→非通知を許可、false→非通知を拒否。"
        },
        "dp.disturb.anonymous.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。"
        },
        "dp.fwd.dialing.callingsec": {
          "type": "number",
          "description": "転送先を呼び出す秒数を指定します。指定した秒数を超えると「無応答」と判断されます。"
        },
        "dp.preforward.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__http_notify",
            "__donothing"
          ],
          "description": "呼び出し前に動作するアクション名を指定します。"
        },
        "dp.fwd.dialing.action": {
          "type": "string",
          "enum": [
            "ring",
            "moh",
            "talkie"
          ],
          "description": "呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）"
        },
        "dp.fwd.dialing.playfile": {
          "type": "string",
          "description": "dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。"
        },
        "dp.fwd.cancel.hangup.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。"
        },
        "dp.fwd.busy.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.busy.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.noanswer.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.noanswer.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.unavailable.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.unavailable.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.answered.prepare.whispering": {
          "type": "boolean",
          "description": "転送先応答時、入電ガイダンスを再生するときにtrueを指定します。"
        },
        "dp.fwd.answered.prepare.playfile": {
          "type": "string",
          "description": "入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。"
        },
        "dp.fwd.answered.leg2discon.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。"
        },
        "dp.fwd.answered.hangup.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "通話が成立した際、通話終了時に動作するアクション名を指定します。"
        },
        "dp.fwd.call_rotate.enable": {
          "type": "boolean",
          "description": "順次転送機能を有効にする際にtrueに設定します。"
        },
        "dp.fwd.call_rotate.phone": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ],
          "description": "順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。"
        },
        "dp.shutdown.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "通話終了時に動作するアクション名を指定します。"
        },
        "dp.email.enable": {
          "type": "boolean",
          "description": "メール通知設定を有効にする際に、trueを指定します。"
        },
        "dp.email.to": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。"
        },
        "dp.http.enable": {
          "type": "boolean",
          "description": "Webプッシュ通知設定を有効にする際に、trueを指定します。"
        },
        "dp.fwd.altphone": {
          "type": "string",
          "description": "転送先変更（__change_fwd）設定時の電話番号を指定します。"
        },
        "dp.vars": {
          "type": "object",
          "properties": {
            "anykey1": {
              "type": "string"
            },
            "anykey2": {
              "type": "string"
            }
          },
          "description": "任意のkey-valueを設定できます。"
        },
        "valid_from": {
          "type": "string",
          "description": "転送を開始する日時。日付の形式で指定してください。指定が無ければ、現在日時で設定します。"
        },
        "valid_until": {
          "type": "string",
          "description": "転送を終了する日時。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。"
        },
        "_exp_at": {
          "type": "string",
          "description": "番号の有効期限。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。有効期限を過ぎると、自動的に番号在庫に戻ります。"
        },
        "dialinID": {
          "type": "string",
          "description": "番号ID。事業者様にて管理している一意なID。任意で設定が可能ですが、全番号を通してユニークな値である必要があります。半角英数字、および、-_.@:を1文字以上で指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。"
        },
        "viewname": {
          "type": "string",
          "description": "管理画面や通話ログに出力する番号の名称。"
        },
        "dp.phone": {
          "type": "string",
          "description": "転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。（広告主の情報を上書きして、異なる番号に転送する場合にのみ指定します。）"
        },
        "dp.forward_enable": {
          "type": "boolean",
          "description": "転送可否。"
        },
        "tags": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ],
          "description": "トラッキング番号に定義するタグを配列で指定します。"
        },
        "_id": {
          "type": "string",
          "description": "システム管理ID。"
        },
        "ct_phone": {
          "type": "string",
          "description": "トラッキング番号。"
        }
      },
      "required": [
        "_id",
        "ct_phone"
      ],
      "description": "APIの実行結果。"
    },
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "trn_tms": {
      "type": "string",
      "description": "処理成功日時。"
    }
  },
  "required": [
    "result",
    "trn_id",
    "trn_tms"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

トラッキング番号発番（番号指定）
POST`/dialins/{partner}/{client}`

トラッキング番号の発番を行います。
トラッキング番号を指定して発番することができます。
要求を受け付けると、指定された番号が番号在庫にあれば、トラッキング番号を発行し、応答します。
リクエストボディ中に番号情報に関するパラメータと電話の動作に関するパラメータを指定してリクエストします。パラメータは以下の通りです。
パラメータの値にnullを指定した場合は、そのパラメータの値にnullが登録されます。

要素名	データ型	必須	説明
ct_phone	string	required	トラッキング番号。電話番号の形式で指定されていない場合はエラーとなります。
valid_from	string	optional	転送を開始する日時。日付の形式で指定してください。指定が無ければ、現在日時で設定します。
valid_until	string	optional	転送を終了する日時。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。
_exp_at	string	optional	番号の有効期限。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。有効期限を過ぎると、自動的に番号在庫に戻ります。
dialinID	string	optional	番号ID。事業者様にて管理している一意なID。任意で設定が可能ですが、全番号を通してユニークな値である必要があります。半角英数字、および、-_.@:を1文字以上で指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。
viewname	string	optional	管理画面や通話ログに出力する番号の名称。
dp.phone	string	optional	転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。（広告主の情報を上書きして、異なる番号に転送する場合にのみ指定します。）
dp.forward_enable	boolean	optional	転送可否。trueが転送する、falseが転送しない、を表します。
tags	array:string	optional	番号に付けるタグを指定。複数指定することができます。

要素名	データ型	必須	説明
dp.talkrec.enable	boolean	optional	通話録音を有効にする際にtrueを設定します。
dp.deny.action	enum	optional	転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.absence.action	enum	optional	不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。有償オプションのため、ご利用には事前に申請が必要となります。
dp.absence.enable	boolean	optional	不在設定のON・OFFを設定します。trueが不在、falseが在席を表します。有償オプションのため、ご利用には事前に申請が必要となります。
dp.recycle.action	enum	optional	リサイクル期間に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.disturb.anonymous.allow	boolean	optional	非通知からの着信拒否を設定します。trueが非通知を許可、falseが非通知を拒否する設定を表します。
dp.disturb.anonymous.action	enum	optional	非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.preforward.action	enum	optional	呼び出し前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.dialing.action	enum	optional	呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）
dp.fwd.dialing.playfile	string	optional	dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。
dp.fwd.cancel.hangup.action	enum	optional	転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.busy.rotate.action	enum	optional	順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.busy.hangup.action	enum	optional	転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.noanswer.rotate.action	enum	optional	順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.noanswer.hangup.action	enum	optional	転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.unavailable.rotate.action	enum	optional	順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.unavailable.hangup.action	enum	optional	転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.answered.prepare.whispering	boolean	optional	転送先応答時、入電ガイダンスを再生するときにtrueを指定します。
dp.fwd.answered.prepare.playfile	string	optional	入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。
dp.fwd.answered.leg2discon.action	enum	optional	通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.answered.hangup.action	enum	optional	通話が成立した際、通話終了時に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.call_rotate.enable	boolean	optional	順次転送機能を有効にする際にtrueに設定します。
dp.fwd.call_rotate.phone	array:string	optional	順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。
dp.shutdown.action	enum	optional	通話終了時に動作するアクション名を指定します。
dp.email.enable	boolean	optional	メール通知設定を有効にする際に、trueを指定します。
dp.email.to	array:string	optional	メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。
dp.http.enable	boolean	optional	Webプッシュ通知設定を有効にする際に、trueを指定します。
dp.fwd.altphone	string	optional	転送先変更（__change_fwd）設定時の電話番号を指定します。
dp.vars	object	optional	任意のkey-valueを設定できます。

URI Parameters

HideShow

partner: string (required) Example: 12345678901234567890abcd
事業者ID
client: string (required) Example: 999999999999999999999999
広告主のシステム管理ID

トラッキング番号変更 ¶

PUT https://api.calltracker.jp/ct/3.0a/dialins/12345678901234567890abcd/999999999999999999999999/501234567800000000000000

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "dp.talkrec.enable": true,
  "dp.deny.action": "__play_guidance",
  "dp.absence.action": "__play_guidance_exit",
  "dp.absence.enable": false,
  "dp.recycle.action": "__play_guidance",
  "dp.disturb.anonymous.allow": true,
  "dp.disturb.anonymous.action": "__play_guidance",
  "dp.fwd.dialing.callingsec": 30,
  "dp.preforward.action": "__play_guidance",
  "dp.fwd.dialing.action": "ring",
  "dp.fwd.dialing.playfile": "1234567890abcdef12345678_moh",
  "dp.fwd.cancel.hangup.action": "__email_notify_noguidance",
  "dp.fwd.busy.rotate.action": "__play_guidance",
  "dp.fwd.busy.hangup.action": "__play_guidance",
  "dp.fwd.noanswer.rotate.action": "__play_guidance",
  "dp.fwd.noanswer.hangup.action": "__play_guidance",
  "dp.fwd.unavailable.rotate.action": "__play_guidance",
  "dp.fwd.unavailable.hangup.action": "__play_guidance",
  "dp.fwd.answered.prepare.whispering": true,
  "dp.fwd.answered.prepare.playfile": "1234567890abcdef12345678_voice",
  "dp.fwd.answered.leg2discon.action": "__play_guidance",
  "dp.fwd.answered.hangup.action": "__email_notify_noguidance",
  "dp.fwd.call_rotate.enable": true,
  "dp.fwd.call_rotate.phone": [
    "09012345678",
    "07098765432"
  ],
  "dp.shutdown.action": "__email_notify_noguidance",
  "dp.email.enable": false,
  "dp.email.to": [
    "sample@comsq.com"
  ],
  "dp.http.enable": false,
  "dp.fwd.altphone": "0399999999",
  "dp.vars": {
    "anykey1": "anykey1",
    "anykey2": "anykey2"
  },
  "valid_from": "2015-06-25T18:17:24+09:00",
  "valid_until": "2015-06-25T18:17:24+09:00",
  "_exp_at": "2015-06-25T18:17:24+09:00",
  "dialinID": "dialinA",
  "viewname": "番号A",
  "dp.phone": "09012345678",
  "dp.forward_enable": true,
  "tags": [
    "test1",
    "test2"
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "dp.talkrec.enable": {
      "type": "boolean",
      "description": "通話録音を有効にする際にtrueを設定します。"
    },
    "dp.deny.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__donothing"
      ],
      "description": "転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。"
    },
    "dp.absence.action": {
      "type": "string",
      "enum": [
        "__play_guidance_exit",
        "__change_fwd",
        "__hangup",
        "__email_notify_exit",
        "__http_notify_exit",
        "__donothing"
      ],
      "description": "不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。"
    },
    "dp.absence.enable": {
      "type": "boolean",
      "description": "不在設定のON・OFFを設定します。true→不在、false→在席。"
    },
    "dp.recycle.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "リサイクル期間に動作するアクション名を指定します。"
    },
    "dp.disturb.anonymous.allow": {
      "type": "boolean",
      "description": "非通知からの着信拒否を設定します。true→非通知を許可、false→非通知を拒否。"
    },
    "dp.disturb.anonymous.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__donothing"
      ],
      "description": "非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。"
    },
    "dp.fwd.dialing.callingsec": {
      "type": "number",
      "description": "転送先を呼び出す秒数を指定します。指定した秒数を超えると「無応答」と判断されます。"
    },
    "dp.preforward.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__http_notify",
        "__donothing"
      ],
      "description": "呼び出し前に動作するアクション名を指定します。"
    },
    "dp.fwd.dialing.action": {
      "type": "string",
      "enum": [
        "ring",
        "moh",
        "talkie"
      ],
      "description": "呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）"
    },
    "dp.fwd.dialing.playfile": {
      "type": "string",
      "description": "dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。"
    },
    "dp.fwd.cancel.hangup.action": {
      "type": "string",
      "enum": [
        "__email_notify_noguidance",
        "__http_notify_noguidance",
        "__donothing"
      ],
      "description": "転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。"
    },
    "dp.fwd.busy.rotate.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。"
    },
    "dp.fwd.busy.hangup.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。"
    },
    "dp.fwd.noanswer.rotate.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。"
    },
    "dp.fwd.noanswer.hangup.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。"
    },
    "dp.fwd.unavailable.rotate.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。"
    },
    "dp.fwd.unavailable.hangup.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__email_notify",
        "__http_notify",
        "__donothing"
      ],
      "description": "転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。"
    },
    "dp.fwd.answered.prepare.whispering": {
      "type": "boolean",
      "description": "転送先応答時、入電ガイダンスを再生するときにtrueを指定します。"
    },
    "dp.fwd.answered.prepare.playfile": {
      "type": "string",
      "description": "入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。"
    },
    "dp.fwd.answered.leg2discon.action": {
      "type": "string",
      "enum": [
        "__play_guidance",
        "__donothing"
      ],
      "description": "通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。"
    },
    "dp.fwd.answered.hangup.action": {
      "type": "string",
      "enum": [
        "__email_notify_noguidance",
        "__http_notify_noguidance",
        "__donothing"
      ],
      "description": "通話が成立した際、通話終了時に動作するアクション名を指定します。"
    },
    "dp.fwd.call_rotate.enable": {
      "type": "boolean",
      "description": "順次転送機能を有効にする際にtrueに設定します。"
    },
    "dp.fwd.call_rotate.phone": {
      "type": "array",
      "items": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。"
    },
    "dp.shutdown.action": {
      "type": "string",
      "enum": [
        "__email_notify_noguidance",
        "__http_notify_noguidance",
        "__donothing"
      ],
      "description": "通話終了時に動作するアクション名を指定します。"
    },
    "dp.email.enable": {
      "type": "boolean",
      "description": "メール通知設定を有効にする際に、trueを指定します。"
    },
    "dp.email.to": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。"
    },
    "dp.http.enable": {
      "type": "boolean",
      "description": "Webプッシュ通知設定を有効にする際に、trueを指定します。"
    },
    "dp.fwd.altphone": {
      "type": "string",
      "description": "転送先変更（__change_fwd）設定時の電話番号を指定します。"
    },
    "dp.vars": {
      "type": "object",
      "properties": {
        "anykey1": {
          "type": "string"
        },
        "anykey2": {
          "type": "string"
        }
      },
      "description": "任意のkey-valueを設定できます。"
    },
    "valid_from": {
      "type": "string",
      "description": "転送を開始する日時。日付の形式で指定してください。指定が無ければ、現在日時で設定します。"
    },
    "valid_until": {
      "type": "string",
      "description": "転送を終了する日時。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。"
    },
    "_exp_at": {
      "type": "string",
      "description": "番号の有効期限。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。有効期限を過ぎると、自動的に番号在庫に戻ります。"
    },
    "dialinID": {
      "type": "string",
      "description": "番号ID。事業者様にて管理している一意なID。任意で設定が可能ですが、全番号を通してユニークな値である必要があります。半角英数字、および、-_.@:を1文字以上で指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。"
    },
    "viewname": {
      "type": "string",
      "description": "管理画面や通話ログに出力する番号の名称。"
    },
    "dp.phone": {
      "type": "string",
      "description": "転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。（広告主の情報を上書きして、異なる番号に転送する場合にのみ指定します。）"
    },
    "dp.forward_enable": {
      "type": "boolean",
      "description": "転送可否。"
    },
    "tags": {
      "type": "array",
      "items": [
        {
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "トラッキング番号に定義するタグを配列で指定します。"
    }
  }
}

Responses200400401403404406409500

Headers

Content-Type: application/json

Body

{
  "result": {
    "dp.talkrec.enable": true,
    "dp.deny.action": "__play_guidance",
    "dp.absence.action": "__play_guidance_exit",
    "dp.absence.enable": false,
    "dp.recycle.action": "__play_guidance",
    "dp.disturb.anonymous.allow": true,
    "dp.disturb.anonymous.action": "__play_guidance",
    "dp.fwd.dialing.callingsec": 30,
    "dp.preforward.action": "__play_guidance",
    "dp.fwd.dialing.action": "ring",
    "dp.fwd.dialing.playfile": "1234567890abcdef12345678_moh",
    "dp.fwd.cancel.hangup.action": "__email_notify_noguidance",
    "dp.fwd.busy.rotate.action": "__play_guidance",
    "dp.fwd.busy.hangup.action": "__play_guidance",
    "dp.fwd.noanswer.rotate.action": "__play_guidance",
    "dp.fwd.noanswer.hangup.action": "__play_guidance",
    "dp.fwd.unavailable.rotate.action": "__play_guidance",
    "dp.fwd.unavailable.hangup.action": "__play_guidance",
    "dp.fwd.answered.prepare.whispering": true,
    "dp.fwd.answered.prepare.playfile": "1234567890abcdef12345678_voice",
    "dp.fwd.answered.leg2discon.action": "__play_guidance",
    "dp.fwd.answered.hangup.action": "__email_notify_noguidance",
    "dp.fwd.call_rotate.enable": true,
    "dp.fwd.call_rotate.phone": [
      "09012345678",
      "07098765432"
    ],
    "dp.shutdown.action": "__email_notify_noguidance",
    "dp.email.enable": false,
    "dp.email.to": [
      "sample@comsq.com"
    ],
    "dp.http.enable": false,
    "dp.fwd.altphone": "0399999999",
    "dp.vars": {
      "anykey1": "anykey1",
      "anykey2": "anykey2"
    },
    "valid_from": "2015-06-25T18:17:24+09:00",
    "valid_until": "2015-06-25T18:17:24+09:00",
    "_exp_at": "2015-06-25T18:17:24+09:00",
    "dialinID": "dialinA",
    "viewname": "番号A",
    "dp.phone": "09012345678",
    "dp.forward_enable": true,
    "tags": [
      "test1",
      "test2"
    ],
    "_id": "501234567800000000000000",
    "ct_phone": "05012345678"
  },
  "trn_id": "570315a53e3f8b166d12945c",
  "trn_tms": "2015-06-25T18:17:24+09:00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "result": {
      "type": "object",
      "properties": {
        "dp.talkrec.enable": {
          "type": "boolean",
          "description": "通話録音を有効にする際にtrueを設定します。"
        },
        "dp.deny.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。"
        },
        "dp.absence.action": {
          "type": "string",
          "enum": [
            "__play_guidance_exit",
            "__change_fwd",
            "__hangup",
            "__email_notify_exit",
            "__http_notify_exit",
            "__donothing"
          ],
          "description": "不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。"
        },
        "dp.absence.enable": {
          "type": "boolean",
          "description": "不在設定のON・OFFを設定します。true→不在、false→在席。"
        },
        "dp.recycle.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "リサイクル期間に動作するアクション名を指定します。"
        },
        "dp.disturb.anonymous.allow": {
          "type": "boolean",
          "description": "非通知からの着信拒否を設定します。true→非通知を許可、false→非通知を拒否。"
        },
        "dp.disturb.anonymous.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。"
        },
        "dp.fwd.dialing.callingsec": {
          "type": "number",
          "description": "転送先を呼び出す秒数を指定します。指定した秒数を超えると「無応答」と判断されます。"
        },
        "dp.preforward.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__http_notify",
            "__donothing"
          ],
          "description": "呼び出し前に動作するアクション名を指定します。"
        },
        "dp.fwd.dialing.action": {
          "type": "string",
          "enum": [
            "ring",
            "moh",
            "talkie"
          ],
          "description": "呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）"
        },
        "dp.fwd.dialing.playfile": {
          "type": "string",
          "description": "dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。"
        },
        "dp.fwd.cancel.hangup.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。"
        },
        "dp.fwd.busy.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.busy.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.noanswer.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.noanswer.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.unavailable.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.unavailable.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.answered.prepare.whispering": {
          "type": "boolean",
          "description": "転送先応答時、入電ガイダンスを再生するときにtrueを指定します。"
        },
        "dp.fwd.answered.prepare.playfile": {
          "type": "string",
          "description": "入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。"
        },
        "dp.fwd.answered.leg2discon.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。"
        },
        "dp.fwd.answered.hangup.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "通話が成立した際、通話終了時に動作するアクション名を指定します。"
        },
        "dp.fwd.call_rotate.enable": {
          "type": "boolean",
          "description": "順次転送機能を有効にする際にtrueに設定します。"
        },
        "dp.fwd.call_rotate.phone": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ],
          "description": "順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。"
        },
        "dp.shutdown.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "通話終了時に動作するアクション名を指定します。"
        },
        "dp.email.enable": {
          "type": "boolean",
          "description": "メール通知設定を有効にする際に、trueを指定します。"
        },
        "dp.email.to": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。"
        },
        "dp.http.enable": {
          "type": "boolean",
          "description": "Webプッシュ通知設定を有効にする際に、trueを指定します。"
        },
        "dp.fwd.altphone": {
          "type": "string",
          "description": "転送先変更（__change_fwd）設定時の電話番号を指定します。"
        },
        "dp.vars": {
          "type": "object",
          "properties": {
            "anykey1": {
              "type": "string"
            },
            "anykey2": {
              "type": "string"
            }
          },
          "description": "任意のkey-valueを設定できます。"
        },
        "valid_from": {
          "type": "string",
          "description": "転送を開始する日時。日付の形式で指定してください。指定が無ければ、現在日時で設定します。"
        },
        "valid_until": {
          "type": "string",
          "description": "転送を終了する日時。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。"
        },
        "_exp_at": {
          "type": "string",
          "description": "番号の有効期限。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。有効期限を過ぎると、自動的に番号在庫に戻ります。"
        },
        "dialinID": {
          "type": "string",
          "description": "番号ID。事業者様にて管理している一意なID。任意で設定が可能ですが、全番号を通してユニークな値である必要があります。半角英数字、および、-_.@:を1文字以上で指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。"
        },
        "viewname": {
          "type": "string",
          "description": "管理画面や通話ログに出力する番号の名称。"
        },
        "dp.phone": {
          "type": "string",
          "description": "転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。（広告主の情報を上書きして、異なる番号に転送する場合にのみ指定します。）"
        },
        "dp.forward_enable": {
          "type": "boolean",
          "description": "転送可否。"
        },
        "tags": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ],
          "description": "トラッキング番号に定義するタグを配列で指定します。"
        },
        "_id": {
          "type": "string",
          "description": "システム管理ID。"
        },
        "ct_phone": {
          "type": "string",
          "description": "トラッキング番号。"
        }
      },
      "required": [
        "_id",
        "ct_phone"
      ],
      "description": "APIの実行結果。"
    },
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "trn_tms": {
      "type": "string",
      "description": "処理成功日時。"
    }
  },
  "required": [
    "result",
    "trn_id",
    "trn_tms"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

トラッキング番号変更
PUT`/dialins/{partner}/{client}/{dialin}`

発番済のトラッキング番号の設定変更を行います。
要求を受け付けると、URLパラメータで指定されたトラッキング番号の情報をリクエストボディの情報に従って変更します。
リクエストボディ中に番号情報に関するパラメータと電話の動作に関するパラメータを指定してリクエストします。パラメータは以下の通りです。
指定されなかった設定値については変更しません。
パラメータの値の削除には対応していません。

要素名	データ型	必須	説明
valid_from	string	optional	転送を開始する日時。日付の形式で指定してください。指定が無ければ、現在日時で設定します。
valid_until	string	optional	転送を終了する日時。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。
_exp_at	string	optional	番号の有効期限。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。有効期限を過ぎると、自動的に番号在庫に戻ります。
dialinID	string	optional	番号ID。事業者様にて管理している一意なID。任意で設定が可能ですが、全番号を通してユニークな値である必要があります。半角英数字、および、-_.@:を1文字以上で指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。
viewname	string	optional	管理画面や通話ログに出力する番号の名称。
dp.phone	string	optional	転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。（広告主の情報を上書きして、異なる番号に転送する場合にのみ指定します。）
dp.forward_enable	boolean	optional	転送可否。trueが転送する、falseが転送しない、を表します。
tags	array:string	optional	番号に付けるタグを指定。複数指定することができます。

要素名	データ型	必須	説明
dp.talkrec.enable	boolean	optional	通話録音を有効にする際にtrueを設定します。
dp.deny.action	enum	optional	転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.absence.action	enum	optional	不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。有償オプションのため、ご利用には事前に申請が必要となります。
dp.absence.enable	boolean	optional	不在設定のON・OFFを設定します。trueが不在、falseが在席を表します。有償オプションのため、ご利用には事前に申請が必要となります。
dp.recycle.action	enum	optional	リサイクル期間に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.disturb.anonymous.allow	boolean	optional	非通知からの着信拒否を設定します。trueが非通知を許可、falseが非通知を拒否する設定を表します。
dp.disturb.anonymous.action	enum	optional	非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.preforward.action	enum	optional	呼び出し前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.dialing.action	enum	optional	呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）
dp.fwd.dialing.playfile	string	optional	dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。
dp.fwd.cancel.hangup.action	enum	optional	転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.busy.rotate.action	enum	optional	順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.busy.hangup.action	enum	optional	転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.noanswer.rotate.action	enum	optional	順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.noanswer.hangup.action	enum	optional	転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.unavailable.rotate.action	enum	optional	順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.unavailable.hangup.action	enum	optional	転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.answered.prepare.whispering	boolean	optional	転送先応答時、入電ガイダンスを再生するときにtrueを指定します。
dp.fwd.answered.prepare.playfile	string	optional	入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。
dp.fwd.answered.leg2discon.action	enum	optional	通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.answered.hangup.action	enum	optional	通話が成立した際、通話終了時に動作するアクション名を指定します。指定できる値は、右記schemaを確認してください。
dp.fwd.call_rotate.enable	boolean	optional	順次転送機能を有効にする際にtrueに設定します。
dp.fwd.call_rotate.phone	array:string	optional	順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。
dp.shutdown.action	enum	optional	通話終了時に動作するアクション名を指定します。
dp.email.enable	boolean	optional	メール通知設定を有効にする際に、trueを指定します。
dp.email.to	array:string	optional	メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。
dp.http.enable	boolean	optional	Webプッシュ通知設定を有効にする際に、trueを指定します。
dp.fwd.altphone	string	optional	転送先変更（__change_fwd）設定時の電話番号を指定します。
dp.vars	object	optional	任意のkey-valueを設定できます。

URI Parameters

HideShow

partner: string (required) Example: 12345678901234567890abcd
事業者ID
client: string (required) Example: 999999999999999999999999
広告主のシステム管理ID
dialin: string (required) Example: 501234567800000000000000
トラッキング番号のシステム管理ID

トラッキング番号削除 ¶

DELETE https://api.calltracker.jp/ct/3.0a/dialins/12345678901234567890abcd/999999999999999999999999/501234567800000000000000

Responses200400401403404406409500

Headers

Content-Type: application/json

Body

{
  "result": {
    "dp.talkrec.enable": true,
    "dp.deny.action": "__play_guidance",
    "dp.absence.action": "__play_guidance_exit",
    "dp.absence.enable": false,
    "dp.recycle.action": "__play_guidance",
    "dp.disturb.anonymous.allow": true,
    "dp.disturb.anonymous.action": "__play_guidance",
    "dp.fwd.dialing.callingsec": 30,
    "dp.preforward.action": "__play_guidance",
    "dp.fwd.dialing.action": "ring",
    "dp.fwd.dialing.playfile": "1234567890abcdef12345678_moh",
    "dp.fwd.cancel.hangup.action": "__email_notify_noguidance",
    "dp.fwd.busy.rotate.action": "__play_guidance",
    "dp.fwd.busy.hangup.action": "__play_guidance",
    "dp.fwd.noanswer.rotate.action": "__play_guidance",
    "dp.fwd.noanswer.hangup.action": "__play_guidance",
    "dp.fwd.unavailable.rotate.action": "__play_guidance",
    "dp.fwd.unavailable.hangup.action": "__play_guidance",
    "dp.fwd.answered.prepare.whispering": true,
    "dp.fwd.answered.prepare.playfile": "1234567890abcdef12345678_voice",
    "dp.fwd.answered.leg2discon.action": "__play_guidance",
    "dp.fwd.answered.hangup.action": "__email_notify_noguidance",
    "dp.fwd.call_rotate.enable": true,
    "dp.fwd.call_rotate.phone": [
      "09012345678",
      "07098765432"
    ],
    "dp.shutdown.action": "__email_notify_noguidance",
    "dp.email.enable": false,
    "dp.email.to": [
      "sample@comsq.com"
    ],
    "dp.http.enable": false,
    "dp.fwd.altphone": "0399999999",
    "dp.vars": {
      "anykey1": "anykey1",
      "anykey2": "anykey2"
    },
    "valid_from": "2015-06-25T18:17:24+09:00",
    "valid_until": "2015-06-25T18:17:24+09:00",
    "_exp_at": "2015-06-25T18:17:24+09:00",
    "dialinID": "dialinA",
    "viewname": "番号A",
    "dp.phone": "09012345678",
    "dp.forward_enable": true,
    "tags": [
      "test1",
      "test2"
    ],
    "_id": "501234567800000000000000",
    "ct_phone": "05012345678"
  },
  "trn_id": "570315a53e3f8b166d12945c",
  "trn_tms": "2015-06-25T18:17:24+09:00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "result": {
      "type": "object",
      "properties": {
        "dp.talkrec.enable": {
          "type": "boolean",
          "description": "通話録音を有効にする際にtrueを設定します。"
        },
        "dp.deny.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。"
        },
        "dp.absence.action": {
          "type": "string",
          "enum": [
            "__play_guidance_exit",
            "__change_fwd",
            "__hangup",
            "__email_notify_exit",
            "__http_notify_exit",
            "__donothing"
          ],
          "description": "不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。"
        },
        "dp.absence.enable": {
          "type": "boolean",
          "description": "不在設定のON・OFFを設定します。true→不在、false→在席。"
        },
        "dp.recycle.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "リサイクル期間に動作するアクション名を指定します。"
        },
        "dp.disturb.anonymous.allow": {
          "type": "boolean",
          "description": "非通知からの着信拒否を設定します。true→非通知を許可、false→非通知を拒否。"
        },
        "dp.disturb.anonymous.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。"
        },
        "dp.fwd.dialing.callingsec": {
          "type": "number",
          "description": "転送先を呼び出す秒数を指定します。指定した秒数を超えると「無応答」と判断されます。"
        },
        "dp.preforward.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__http_notify",
            "__donothing"
          ],
          "description": "呼び出し前に動作するアクション名を指定します。"
        },
        "dp.fwd.dialing.action": {
          "type": "string",
          "enum": [
            "ring",
            "moh",
            "talkie"
          ],
          "description": "呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）"
        },
        "dp.fwd.dialing.playfile": {
          "type": "string",
          "description": "dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。"
        },
        "dp.fwd.cancel.hangup.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。"
        },
        "dp.fwd.busy.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.busy.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.noanswer.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.noanswer.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.unavailable.rotate.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。"
        },
        "dp.fwd.unavailable.hangup.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__email_notify",
            "__http_notify",
            "__donothing"
          ],
          "description": "転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。"
        },
        "dp.fwd.answered.prepare.whispering": {
          "type": "boolean",
          "description": "転送先応答時、入電ガイダンスを再生するときにtrueを指定します。"
        },
        "dp.fwd.answered.prepare.playfile": {
          "type": "string",
          "description": "入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。"
        },
        "dp.fwd.answered.leg2discon.action": {
          "type": "string",
          "enum": [
            "__play_guidance",
            "__donothing"
          ],
          "description": "通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。"
        },
        "dp.fwd.answered.hangup.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "通話が成立した際、通話終了時に動作するアクション名を指定します。"
        },
        "dp.fwd.call_rotate.enable": {
          "type": "boolean",
          "description": "順次転送機能を有効にする際にtrueに設定します。"
        },
        "dp.fwd.call_rotate.phone": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ],
          "description": "順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。"
        },
        "dp.shutdown.action": {
          "type": "string",
          "enum": [
            "__email_notify_noguidance",
            "__http_notify_noguidance",
            "__donothing"
          ],
          "description": "通話終了時に動作するアクション名を指定します。"
        },
        "dp.email.enable": {
          "type": "boolean",
          "description": "メール通知設定を有効にする際に、trueを指定します。"
        },
        "dp.email.to": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。"
        },
        "dp.http.enable": {
          "type": "boolean",
          "description": "Webプッシュ通知設定を有効にする際に、trueを指定します。"
        },
        "dp.fwd.altphone": {
          "type": "string",
          "description": "転送先変更（__change_fwd）設定時の電話番号を指定します。"
        },
        "dp.vars": {
          "type": "object",
          "properties": {
            "anykey1": {
              "type": "string"
            },
            "anykey2": {
              "type": "string"
            }
          },
          "description": "任意のkey-valueを設定できます。"
        },
        "valid_from": {
          "type": "string",
          "description": "転送を開始する日時。日付の形式で指定してください。指定が無ければ、現在日時で設定します。"
        },
        "valid_until": {
          "type": "string",
          "description": "転送を終了する日時。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。"
        },
        "_exp_at": {
          "type": "string",
          "description": "番号の有効期限。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。有効期限を過ぎると、自動的に番号在庫に戻ります。"
        },
        "dialinID": {
          "type": "string",
          "description": "番号ID。事業者様にて管理している一意なID。任意で設定が可能ですが、全番号を通してユニークな値である必要があります。半角英数字、および、-_.@:を1文字以上で指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。"
        },
        "viewname": {
          "type": "string",
          "description": "管理画面や通話ログに出力する番号の名称。"
        },
        "dp.phone": {
          "type": "string",
          "description": "転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。（広告主の情報を上書きして、異なる番号に転送する場合にのみ指定します。）"
        },
        "dp.forward_enable": {
          "type": "boolean",
          "description": "転送可否。"
        },
        "tags": {
          "type": "array",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "string"
            }
          ],
          "description": "トラッキング番号に定義するタグを配列で指定します。"
        },
        "_id": {
          "type": "string",
          "description": "システム管理ID。"
        },
        "ct_phone": {
          "type": "string",
          "description": "トラッキング番号。"
        }
      },
      "required": [
        "_id",
        "ct_phone"
      ],
      "description": "APIの実行結果。"
    },
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "trn_tms": {
      "type": "string",
      "description": "処理成功日時。"
    }
  },
  "required": [
    "result",
    "trn_id",
    "trn_tms"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

トラッキング番号削除
DELETE`/dialins/{partner}/{client}/{dialin}`

発番済のトラッキング番号の削除を行います。
要求を受け付けると、URLパラメータで指定されたトラッキング番号の情報を削除します。
指定されなかった設定値については変更しません。

URI Parameters

HideShow

partner: string (required) Example: 12345678901234567890abcd
事業者ID
client: string (required) Example: 999999999999999999999999
広告主のシステム管理ID
dialin: string (required) Example: 501234567800000000000000
トラッキング番号のシステム管理ID

トラッキング番号情報一覧取得 ¶

GET https://api.calltracker.jp/ct/3.0a/dialins/12345678901234567890abcd/999999999999999999999999

Responses200400401403404406409500

Headers

Content-Type: application/json

Body

{
  "result": [
    {
      "dp.talkrec.enable": true,
      "dp.deny.action": "__play_guidance",
      "dp.absence.action": "__play_guidance_exit",
      "dp.absence.enable": false,
      "dp.recycle.action": "__play_guidance",
      "dp.disturb.anonymous.allow": true,
      "dp.disturb.anonymous.action": "__play_guidance",
      "dp.fwd.dialing.callingsec": 30,
      "dp.preforward.action": "__play_guidance",
      "dp.fwd.dialing.action": "ring",
      "dp.fwd.dialing.playfile": "1234567890abcdef12345678_moh",
      "dp.fwd.cancel.hangup.action": "__email_notify_noguidance",
      "dp.fwd.busy.rotate.action": "__play_guidance",
      "dp.fwd.busy.hangup.action": "__play_guidance",
      "dp.fwd.noanswer.rotate.action": "__play_guidance",
      "dp.fwd.noanswer.hangup.action": "__play_guidance",
      "dp.fwd.unavailable.rotate.action": "__play_guidance",
      "dp.fwd.unavailable.hangup.action": "__play_guidance",
      "dp.fwd.answered.prepare.whispering": true,
      "dp.fwd.answered.prepare.playfile": "1234567890abcdef12345678_voice",
      "dp.fwd.answered.leg2discon.action": "__play_guidance",
      "dp.fwd.answered.hangup.action": "__email_notify_noguidance",
      "dp.fwd.call_rotate.enable": true,
      "dp.fwd.call_rotate.phone": [
        "09012345678",
        "07098765432"
      ],
      "dp.shutdown.action": "__email_notify_noguidance",
      "dp.email.enable": false,
      "dp.email.to": [
        "sample@comsq.com"
      ],
      "dp.http.enable": false,
      "dp.fwd.altphone": "0399999999",
      "dp.vars": {
        "anykey1": "anykey1",
        "anykey2": "anykey2"
      },
      "valid_from": "2015-06-25T18:17:24+09:00",
      "valid_until": "2015-06-25T18:17:24+09:00",
      "_exp_at": "2015-06-25T18:17:24+09:00",
      "dialinID": "dialinA",
      "viewname": "番号A",
      "dp.phone": "09012345678",
      "dp.forward_enable": true,
      "tags": [
        "test1",
        "test2"
      ],
      "_id": "571f22f065a298a60a20ab69"
    }
  ],
  "trn_id": "570315a53e3f8b166d12945c",
  "trn_tms": "2015-06-25T18:17:24+09:00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "dp.talkrec.enable": {
            "type": "boolean",
            "description": "通話録音を有効にする際にtrueを設定します。"
          },
          "dp.deny.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__donothing"
            ],
            "description": "転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。"
          },
          "dp.absence.action": {
            "type": "string",
            "enum": [
              "__play_guidance_exit",
              "__change_fwd",
              "__hangup",
              "__email_notify_exit",
              "__http_notify_exit",
              "__donothing"
            ],
            "description": "不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。"
          },
          "dp.absence.enable": {
            "type": "boolean",
            "description": "不在設定のON・OFFを設定します。true→不在、false→在席。"
          },
          "dp.recycle.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "リサイクル期間に動作するアクション名を指定します。"
          },
          "dp.disturb.anonymous.allow": {
            "type": "boolean",
            "description": "非通知からの着信拒否を設定します。true→非通知を許可、false→非通知を拒否。"
          },
          "dp.disturb.anonymous.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__donothing"
            ],
            "description": "非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。"
          },
          "dp.fwd.dialing.callingsec": {
            "type": "number",
            "description": "転送先を呼び出す秒数を指定します。指定した秒数を超えると「無応答」と判断されます。"
          },
          "dp.preforward.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__http_notify",
              "__donothing"
            ],
            "description": "呼び出し前に動作するアクション名を指定します。"
          },
          "dp.fwd.dialing.action": {
            "type": "string",
            "enum": [
              "ring",
              "moh",
              "talkie"
            ],
            "description": "呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）"
          },
          "dp.fwd.dialing.playfile": {
            "type": "string",
            "description": "dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。"
          },
          "dp.fwd.cancel.hangup.action": {
            "type": "string",
            "enum": [
              "__email_notify_noguidance",
              "__http_notify_noguidance",
              "__donothing"
            ],
            "description": "転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。"
          },
          "dp.fwd.busy.rotate.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。"
          },
          "dp.fwd.busy.hangup.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。"
          },
          "dp.fwd.noanswer.rotate.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。"
          },
          "dp.fwd.noanswer.hangup.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。"
          },
          "dp.fwd.unavailable.rotate.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。"
          },
          "dp.fwd.unavailable.hangup.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。"
          },
          "dp.fwd.answered.prepare.whispering": {
            "type": "boolean",
            "description": "転送先応答時、入電ガイダンスを再生するときにtrueを指定します。"
          },
          "dp.fwd.answered.prepare.playfile": {
            "type": "string",
            "description": "入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。"
          },
          "dp.fwd.answered.leg2discon.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__donothing"
            ],
            "description": "通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。"
          },
          "dp.fwd.answered.hangup.action": {
            "type": "string",
            "enum": [
              "__email_notify_noguidance",
              "__http_notify_noguidance",
              "__donothing"
            ],
            "description": "通話が成立した際、通話終了時に動作するアクション名を指定します。"
          },
          "dp.fwd.call_rotate.enable": {
            "type": "boolean",
            "description": "順次転送機能を有効にする際にtrueに設定します。"
          },
          "dp.fwd.call_rotate.phone": {
            "type": "array",
            "items": [
              {
                "type": "string"
              },
              {
                "type": "string"
              }
            ],
            "description": "順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。"
          },
          "dp.shutdown.action": {
            "type": "string",
            "enum": [
              "__email_notify_noguidance",
              "__http_notify_noguidance",
              "__donothing"
            ],
            "description": "通話終了時に動作するアクション名を指定します。"
          },
          "dp.email.enable": {
            "type": "boolean",
            "description": "メール通知設定を有効にする際に、trueを指定します。"
          },
          "dp.email.to": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。"
          },
          "dp.http.enable": {
            "type": "boolean",
            "description": "Webプッシュ通知設定を有効にする際に、trueを指定します。"
          },
          "dp.fwd.altphone": {
            "type": "string",
            "description": "転送先変更（__change_fwd）設定時の電話番号を指定します。"
          },
          "dp.vars": {
            "type": "object",
            "properties": {
              "anykey1": {
                "type": "string"
              },
              "anykey2": {
                "type": "string"
              }
            },
            "description": "任意のkey-valueを設定できます。"
          },
          "valid_from": {
            "type": "string",
            "description": "転送を開始する日時。日付の形式で指定してください。指定が無ければ、現在日時で設定します。"
          },
          "valid_until": {
            "type": "string",
            "description": "転送を終了する日時。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。"
          },
          "_exp_at": {
            "type": "string",
            "description": "番号の有効期限。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。有効期限を過ぎると、自動的に番号在庫に戻ります。"
          },
          "dialinID": {
            "type": "string",
            "description": "番号ID。事業者様にて管理している一意なID。任意で設定が可能ですが、全番号を通してユニークな値である必要があります。半角英数字、および、-_.@:を1文字以上で指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。"
          },
          "viewname": {
            "type": "string",
            "description": "管理画面や通話ログに出力する番号の名称。"
          },
          "dp.phone": {
            "type": "string",
            "description": "転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。（広告主の情報を上書きして、異なる番号に転送する場合にのみ指定します。）"
          },
          "dp.forward_enable": {
            "type": "boolean",
            "description": "転送可否。"
          },
          "tags": {
            "type": "array",
            "items": [
              {
                "type": "string"
              },
              {
                "type": "string"
              }
            ],
            "description": "トラッキング番号に定義するタグを配列で指定します。"
          },
          "_id": {
            "type": "string",
            "description": "システム管理ID。"
          }
        },
        "required": [
          "_id"
        ]
      }
    },
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "trn_tms": {
      "type": "string",
      "description": "処理成功日時。"
    }
  },
  "required": [
    "result",
    "trn_id",
    "trn_tms"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

トラッキング番号情報一覧取得
GET`/dialins/{partner}/{client}`

発番済のトラッキング番号の情報を取得します。
要求を受け付けると、URLパラメータで指定された広告主の情報を全て応答します。
事業者全体の番号を一覧取得することはできません。

URI Parameters

HideShow

partner: string (required) Example: 12345678901234567890abcd
事業者ID
client: string (required) Example: 999999999999999999999999
広告主のシステム管理ID

トラッキング番号情報一件取得 ¶

GET https://api.calltracker.jp/ct/3.0a/dialins/12345678901234567890abcd/999999999999999999999999/501234567800000000000000

Responses200400401403404406409500

Headers

Content-Type: application/json

Body

{
  "result": [
    {
      "dp.talkrec.enable": true,
      "dp.deny.action": "__play_guidance",
      "dp.absence.action": "__play_guidance_exit",
      "dp.absence.enable": false,
      "dp.recycle.action": "__play_guidance",
      "dp.disturb.anonymous.allow": true,
      "dp.disturb.anonymous.action": "__play_guidance",
      "dp.fwd.dialing.callingsec": 30,
      "dp.preforward.action": "__play_guidance",
      "dp.fwd.dialing.action": "ring",
      "dp.fwd.dialing.playfile": "1234567890abcdef12345678_moh",
      "dp.fwd.cancel.hangup.action": "__email_notify_noguidance",
      "dp.fwd.busy.rotate.action": "__play_guidance",
      "dp.fwd.busy.hangup.action": "__play_guidance",
      "dp.fwd.noanswer.rotate.action": "__play_guidance",
      "dp.fwd.noanswer.hangup.action": "__play_guidance",
      "dp.fwd.unavailable.rotate.action": "__play_guidance",
      "dp.fwd.unavailable.hangup.action": "__play_guidance",
      "dp.fwd.answered.prepare.whispering": true,
      "dp.fwd.answered.prepare.playfile": "1234567890abcdef12345678_voice",
      "dp.fwd.answered.leg2discon.action": "__play_guidance",
      "dp.fwd.answered.hangup.action": "__email_notify_noguidance",
      "dp.fwd.call_rotate.enable": true,
      "dp.fwd.call_rotate.phone": [
        "09012345678",
        "07098765432"
      ],
      "dp.shutdown.action": "__email_notify_noguidance",
      "dp.email.enable": false,
      "dp.email.to": [
        "sample@comsq.com"
      ],
      "dp.http.enable": false,
      "dp.fwd.altphone": "0399999999",
      "dp.vars": {
        "anykey1": "anykey1",
        "anykey2": "anykey2"
      },
      "valid_from": "2015-06-25T18:17:24+09:00",
      "valid_until": "2015-06-25T18:17:24+09:00",
      "_exp_at": "2015-06-25T18:17:24+09:00",
      "dialinID": "dialinA",
      "viewname": "番号A",
      "dp.phone": "09012345678",
      "dp.forward_enable": true,
      "tags": [
        "test1",
        "test2"
      ],
      "_id": "571f22f065a298a60a20ab69"
    }
  ],
  "trn_id": "570315a53e3f8b166d12945c",
  "trn_tms": "2015-06-25T18:17:24+09:00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "dp.talkrec.enable": {
            "type": "boolean",
            "description": "通話録音を有効にする際にtrueを設定します。"
          },
          "dp.deny.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__donothing"
            ],
            "description": "転送OFF時（dp.foward_enableがfalse）に動作するアクション名を指定します。"
          },
          "dp.absence.action": {
            "type": "string",
            "enum": [
              "__play_guidance_exit",
              "__change_fwd",
              "__hangup",
              "__email_notify_exit",
              "__http_notify_exit",
              "__donothing"
            ],
            "description": "不在時（dp.absence.enableがtrue）に動作するアクション名を指定します。"
          },
          "dp.absence.enable": {
            "type": "boolean",
            "description": "不在設定のON・OFFを設定します。true→不在、false→在席。"
          },
          "dp.recycle.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "リサイクル期間に動作するアクション名を指定します。"
          },
          "dp.disturb.anonymous.allow": {
            "type": "boolean",
            "description": "非通知からの着信拒否を設定します。true→非通知を許可、false→非通知を拒否。"
          },
          "dp.disturb.anonymous.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__donothing"
            ],
            "description": "非通知拒否時（dp.disturb.anonymous.allowがfalse）に動作するアクション名を指定します。"
          },
          "dp.fwd.dialing.callingsec": {
            "type": "number",
            "description": "転送先を呼び出す秒数を指定します。指定した秒数を超えると「無応答」と判断されます。"
          },
          "dp.preforward.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__http_notify",
              "__donothing"
            ],
            "description": "呼び出し前に動作するアクション名を指定します。"
          },
          "dp.fwd.dialing.action": {
            "type": "string",
            "enum": [
              "ring",
              "moh",
              "talkie"
            ],
            "description": "呼び出し中の動作を設定します。ring→プルルル音、moh→呼び出しガイダンスを流す、talkie→転送先側が流す音声をそのまま流す。（IVR等）"
          },
          "dp.fwd.dialing.playfile": {
            "type": "string",
            "description": "dp.fwd.dialing.actionにmohを指定した際に、呼び出しガイダンス名を指定します。"
          },
          "dp.fwd.cancel.hangup.action": {
            "type": "string",
            "enum": [
              "__email_notify_noguidance",
              "__http_notify_noguidance",
              "__donothing"
            ],
            "description": "転送先が応答する前に、発信者側が電話を切ったときに動作するアクションを指定します。"
          },
          "dp.fwd.busy.rotate.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が話中だったときに次の番号に転送する前に動作するアクション名を指定します。"
          },
          "dp.fwd.busy.hangup.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "転送先が話中だったとき、電話を切断する前に動作するアクション名を指定します。"
          },
          "dp.fwd.noanswer.rotate.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先が無応答だったときに次の番号に転送する前に動作するアクション名を指定します。"
          },
          "dp.fwd.noanswer.hangup.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "転送先が無応答だったとき、電話を切断する前に動作するアクション名を指定します。"
          },
          "dp.fwd.unavailable.rotate.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "順次転送設定時（dp.fwd.call_rotate.enableがtrue）、転送先がキャリア側の要因でつながらなかったときに次の番号に転送する前に動作するアクション名を指定します。"
          },
          "dp.fwd.unavailable.hangup.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__email_notify",
              "__http_notify",
              "__donothing"
            ],
            "description": "転送先がキャリア側の要因でつながらなかったとき、電話を切断する前に動作するアクション名を指定します。"
          },
          "dp.fwd.answered.prepare.whispering": {
            "type": "boolean",
            "description": "転送先応答時、入電ガイダンスを再生するときにtrueを指定します。"
          },
          "dp.fwd.answered.prepare.playfile": {
            "type": "string",
            "description": "入電ガイダンスの再生をONにしたとき（dp.fwd.answered.prepare.whisperingがtrue）、入電ガイダンス名を指定します。"
          },
          "dp.fwd.answered.leg2discon.action": {
            "type": "string",
            "enum": [
              "__play_guidance",
              "__donothing"
            ],
            "description": "通話が成立し、発信者側が通話終了したときに動作するアクション名を指定します。"
          },
          "dp.fwd.answered.hangup.action": {
            "type": "string",
            "enum": [
              "__email_notify_noguidance",
              "__http_notify_noguidance",
              "__donothing"
            ],
            "description": "通話が成立した際、通話終了時に動作するアクション名を指定します。"
          },
          "dp.fwd.call_rotate.enable": {
            "type": "boolean",
            "description": "順次転送機能を有効にする際にtrueに設定します。"
          },
          "dp.fwd.call_rotate.phone": {
            "type": "array",
            "items": [
              {
                "type": "string"
              },
              {
                "type": "string"
              }
            ],
            "description": "順次転送機能が有効時、2番目以降の転送先番号を配列で指定します。"
          },
          "dp.shutdown.action": {
            "type": "string",
            "enum": [
              "__email_notify_noguidance",
              "__http_notify_noguidance",
              "__donothing"
            ],
            "description": "通話終了時に動作するアクション名を指定します。"
          },
          "dp.email.enable": {
            "type": "boolean",
            "description": "メール通知設定を有効にする際に、trueを指定します。"
          },
          "dp.email.to": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "メール通知設定時(dp.email.enableがtrue)、宛先のメールアドレスを配列で指定します。"
          },
          "dp.http.enable": {
            "type": "boolean",
            "description": "Webプッシュ通知設定を有効にする際に、trueを指定します。"
          },
          "dp.fwd.altphone": {
            "type": "string",
            "description": "転送先変更（__change_fwd）設定時の電話番号を指定します。"
          },
          "dp.vars": {
            "type": "object",
            "properties": {
              "anykey1": {
                "type": "string"
              },
              "anykey2": {
                "type": "string"
              }
            },
            "description": "任意のkey-valueを設定できます。"
          },
          "valid_from": {
            "type": "string",
            "description": "転送を開始する日時。日付の形式で指定してください。指定が無ければ、現在日時で設定します。"
          },
          "valid_until": {
            "type": "string",
            "description": "転送を終了する日時。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。"
          },
          "_exp_at": {
            "type": "string",
            "description": "番号の有効期限。日付の形式で指定してください。指定が無ければ、2099-12-31T23:59:59+09:00を設定します。有効期限を過ぎると、自動的に番号在庫に戻ります。"
          },
          "dialinID": {
            "type": "string",
            "description": "番号ID。事業者様にて管理している一意なID。任意で設定が可能ですが、全番号を通してユニークな値である必要があります。半角英数字、および、-_.@:を1文字以上で指定してください。指定が無かった場合は、コールトラッカーのシステム管理IDを設定します。"
          },
          "viewname": {
            "type": "string",
            "description": "管理画面や通話ログに出力する番号の名称。"
          },
          "dp.phone": {
            "type": "string",
            "description": "転送先電話番号。電話番号の形式で指定されていない場合はエラーとなります。（広告主の情報を上書きして、異なる番号に転送する場合にのみ指定します。）"
          },
          "dp.forward_enable": {
            "type": "boolean",
            "description": "転送可否。"
          },
          "tags": {
            "type": "array",
            "items": [
              {
                "type": "string"
              },
              {
                "type": "string"
              }
            ],
            "description": "トラッキング番号に定義するタグを配列で指定します。"
          },
          "_id": {
            "type": "string",
            "description": "システム管理ID。"
          }
        },
        "required": [
          "_id"
        ]
      }
    },
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "trn_tms": {
      "type": "string",
      "description": "処理成功日時。"
    }
  },
  "required": [
    "result",
    "trn_id",
    "trn_tms"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

トラッキング番号情報一件取得
GET`/dialins/{partner}/{client}/{dialin}`

発番済のトラッキング番号の情報を取得します。
要求を受け付けると、URLパラメータで指定された広告主の情報を全て応答します。
事業者全体の番号を一覧取得することはできません。

URI Parameters

HideShow

partner: string (required) Example: 12345678901234567890abcd
事業者ID
client: string (required) Example: 999999999999999999999999
広告主のシステム管理ID
dialin: string (required) Example: 501234567800000000000000
トラッキング番号のシステム管理ID

通話ログ ¶

通話ログの取得を行います。

通話ログ取得 ¶

GET https://api.calltracker.jp/ct/3.0a/calllogs/12345678901234567890abcd?start=2016-01-01T00:00:00+0900&end=2017-01-01T00:00:00+0900&din_id=05012345678&fwd_id=09012345678&client_id=clientA&hup_usr[]=1&dial_stat[]=ANSWER&format=csv&charset=utf-8&archive=plain&ctag_or[]=ctag01&ctag_and[]=ctag01&dtag_or[]=dtag01&dtag_and[]=dtag01

Responses200200200400401403404406409500

Headers

Content-Type: text/csv

Body

"ログ番号","処理ID","トラッキング番号","広告主ID","広告主名","トラッキング番号ID","番号名","・・・・"
"100022121","59a3864fdc146805607xxxxx","05012345678","sample_clientidA","サンプル広告主A","sample_dialinidA","サンプル番号A","・・・・"
"100022122","59a3864fdc146805607yyyyy","05012345679","sample_clientidB","サンプル広告主B","sample_dialinidB","サンプル番号B","・・・・"
"100022123","59a3864fdc146805607zzzzz","05012345680","sample_clientidC","サンプル広告主C","sample_dialinidC","サンプル番号C","・・・・"

Headers

Content-Type: text/tsv

Body

"ログ番号"  "処理ID" "トラッキング番号"  "広告主ID"    "広告主名"    "トラッキング番号ID"    "番号名"    "・・・・"
"100022121"    "59a3864fdc146805607xxxxx"    "05012345678"    "sample_clientidA"    "サンプル広告主A"    "sample_dialinidA"    "サンプル番号A"    "・・・・"
"100022122"    "59a3864fdc146805607yyyyy"    "05012345679"    "sample_clientidB"    "サンプル広告主B"    "sample_dialinidB"    "サンプル番号B"    "・・・・"
"100022123"    "59a3864fdc146805607zzzzz"    "05012345680"    "sample_clientidC"    "サンプル広告主C"    "sample_dialinidC"    "サンプル番号C"    "・・・・"

Headers

Content-Type: application/json

Body

[
  {
    "_id": "59a386e10e5c2d4249001718",
    "seq_num": 100022121,
    "trn_id": "59a3864fdc14680560xxxxxx",
    "clr_id_cipher": "03445591Ncw",
    "・・・": "・・・"
  },
  {
    "_id": "59a60f380e5c2d42490017e6",
    "seq_num": 100022122,
    "trn_id": "59a60eafbfa5ae62d3yyyyyy",
    "clr_id_cipher": "03445591Ncw",
    "・・・": "・・・"
  },
  {
    "_id": "59a641610e5c2d4249001823",
    "seq_num": 100022123,
    "trn_id": "59a640e2bfa5ae0504zzzzzz",
    "clr_id_cipher": "03445591Ncw",
    "・・・": "・・・"
  }
]

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

通話ログ取得
GET`/calllogs/{partner}{?start,end,din_id,fwd_id,client_id,hup_usr[],dial_stat[],format,charset,archive,ctag_or[],ctag_and[],dtag_or[],dtag_and[]}`

通話ログの取得を行います。
指定された日時範囲に含まれる着信日時のログを応答します。
出力項目については、任意の項目を返すように事前に設定することが可能です。
format=jsonを指定した場合のkeyについては、オンラインマニュアルの「通話ログ画面の項目説明」に記載があります。
通話ログは取得可能になるまで、終話から最大5分程度かかります。
クエリパラメータついては、URLエンコードをした状態でリクエストしてください。

URI Parameters

HideShow

partner

string (required) Example: 12345678901234567890abcd

事業者ID

start

string (optional) Example: 2016-01-01T00:00:00+0900

取得するログの日時範囲。指定した日時以降のログを返します。

end

string (optional) Example: 2017-01-01T00:00:00+0900

取得するログの日時範囲。指定した日時未満のログを返します。

din_id

string (optional) Example: 05012345678

トラッキング番号。前方一致検索を行い、ログを返します。

fwd_id

string (optional) Example: 09012345678

転送先番号。前方一致検索を行い、ログを返します。

client_id

string (optional) Example: clientA

広告主ID。完全一致検索を行い、ログを返します。

agency_name

string (optional) Example: 代理店A

代理店名。部分一致検索を行い、ログを返します。

hup_usr[]

number (optional) Example: 1

切断者。配列で指定し、その内容でOR検索を行います。 1→発信者側、2→転送先側

Choices: 1 2

dial_stat[]

string (optional) Example: ANSWER

転送状況。配列で指定し、その内容でOR検索を行います。・ANSWER→正常通話・CANCEL→キャンセル・BUSY→通話中・NOANSWER→無応答・CHANUNAVAIL→キャリア側切断・CONGESTION→回線輻輳

Choices: ANSWER CANCEL BUSY NOANSWER CHANUNAVAIL CONGESTION

call_decision

boolean (optional) Example: true

成果/非成果。trueを指定すると成果のみ、falseを指定すると非成果のみのログを返します。未指定の場合は成果と非成果のログを両方返します。なお、修正を行った場合は、修正後の結果で検索します。

format

string (optional) Default: csv Example: csv

出力フォーマット。

Choices: csv json tsv

charset

string (optional) Default: utf-8 Example: utf-8

出力文字コード。formatがjson形式の場合は、指定にかかわらずutf-8で返却します。

Choices: utf-8 sjis

archive

string (optional) Default: plain Example: plain

出力方式。plain→プレーンテキストで返却、file→ファイルで返却、zip→zip形式で圧縮して返却、gzip→gzip形式で圧縮して返却。

Choices: plain file zip gzip

ctag_or[]

string (optional) Example: ctag01

広告主タグ。複数指定した場合は、一つでも一致すれば対象の通話ログを出力します。

Choices: -- 任意のタグ名 --

ctag_and[]

string (optional) Example: ctag01

広告主タグ。複数指定した場合は、全てに一致した場合のみ対象の通話ログを出力します。

Choices: -- 任意のタグ名 --

dtag_or[]

string (optional) Example: dtag01

トラッキング番号タグ。複数指定した場合は、一つでも一致すれば対象の通話ログを出力します。

Choices: -- 任意のタグ名 --

dtag_and[]

string (optional) Example: dtag01

トラッキング番号タグ。複数指定した場合は、全てに一致した場合のみ対象の通話ログを出力します。

Choices: -- 任意のタグ名 --

通話録音ファイル ¶

指定された通話ログIDに紐づく、通話録音ファイルを取得します。

通話録音ファイル取得 ¶

GET https://api.calltracker.jp/ct/3.0a/signed_url/calllog_vrec/12345678901234567890abcd?calllog_id=999999999999999999999999&expires=1800&allow_ipaddr=192.168.1.2/24

Responses200400401403404406409500

Headers

Content-Type: application/json

Body

{
  "result": {
    "signed_url": "https://cdn.calltracker.jp/12345678901234567890abcd/・・・・・"
  },
  "trn_id": "570315a53e3f8b166d12945c",
  "trn_tms": "2015-06-25T18:17:24+09:00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "result": {
      "type": "object",
      "properties": {
        "signed_url": {
          "type": "string",
          "description": "発行された通話録音ファイルのダウンロードURL。"
        }
      },
      "required": [
        "signed_url"
      ],
      "description": "APIの実行結果。"
    },
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "trn_tms": {
      "type": "string",
      "description": "処理成功日時。"
    }
  },
  "required": [
    "result",
    "trn_id",
    "trn_tms"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

通話録音ファイル取得
GET`/signed_url/calllog_vrec/{partner}{?calllog_id,expires,allow_ipaddr}`

指定された通話ログIDに紐づく、通話録音ファイルのダウンロードURLを取得します。
通話ログの処理ID、URLの有効期限、アクセスを許可するIPアドレスを元にURLをリクエストします。
返却されたURLにアクセスすると、通話録音ファイルを取得することができます。
URLの有効期限を過ぎると、403のステータスを返し、ファイルを取得することができなくなります。
許可したIPアドレス以外からのダウンロードリクエストを受けても、403のステータスを返し、ファイルの取得はできません。

URI Parameters

HideShow

partner: string (required) Example: 12345678901234567890abcd
事業者ID
calllog_id: string (required) Example: 999999999999999999999999
取得したい通話録音ファイルに紐づく、通話ログの処理ID。
expires: number (optional) Example: 1800
URLの有効期限。秒で指定。10～1800の間で指定が可能で、省略時は900となります。
allow_ipaddr: string (optional) Example: 192.168.1.2/24
アクセスを許可するIPアドレス。IPv4・CIDR形式のIPv4をひとつだけ指定できます。省略時はIPアドレス制限を行いません。

通話テキスト化ファイル ¶

指定された通話ログIDに紐づく、通話テキスト化ファイルを取得します。

通話テキスト化ファイル取得 ¶

GET https://api.calltracker.jp/ct/3.0a/signed_url/calllog_vtext/12345678901234567890abcd?calllog_id=999999999999999999999999&expires=1800&allow_ipaddr=192.168.1.2/24&format=flat

Responses200400401403404406409500

Headers

Content-Type: application/json

Body

{
  "result": {
    "signed_url": "https://cdn.calltracker.jp/transcribe-text/12345678901234567890abcd/・・・・・"
  },
  "trn_id": "570315a53e3f8b166d12945c",
  "trn_tms": "2015-06-25T18:17:24+09:00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "result": {
      "type": "object",
      "properties": {
        "signed_url": {
          "type": "string",
          "description": "発行された通話テキスト化ファイルのダウンロードURL。"
        }
      },
      "required": [
        "signed_url"
      ],
      "description": "APIの実行結果。"
    },
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "trn_tms": {
      "type": "string",
      "description": "処理成功日時。"
    }
  },
  "required": [
    "result",
    "trn_id",
    "trn_tms"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

通話テキスト化ファイル取得
GET`/signed_url/calllog_vtext/{partner}{?calllog_id,expires,allow_ipaddr,format}`

指定された通話ログIDに紐づく、通話テキスト化ファイルのダウンロードURLを取得します。
通話ログの処理ID、URLの有効期限、アクセスを許可するIPアドレス、および取得するファイル形式を元にURLをリクエストします。
返却されたURLにアクセスすると、通話テキスト化ファイルを取得することができます。
URLの有効期限を過ぎると、403のステータスを返し、ファイルを取得することができなくなります。
許可したIPアドレス以外からのダウンロードリクエストを受けても、403のステータスを返し、ファイルの取得はできません。
クエリパラメータformatにより、オブジェクトストレージ上のどの形式のテキスト化成果物を指すかを指定します。flat（省略時）の場合は、事業者設定（serviceconf.transcribe.format）に従います。json・csv・tsvを指定した場合は、その形式名をキーとしてlogvars.vrsresult内のS3情報を参照します。

URI Parameters

HideShow

partner: string (required) Example: 12345678901234567890abcd
事業者ID
calllog_id: string (required) Example: 999999999999999999999999
取得したい通話テキスト化ファイルに紐づく、通話ログの処理ID。
expires: number (optional) Example: 1800
URLの有効期限。秒で指定。10～1800の間で指定が可能で、省略時は900となります。
allow_ipaddr: string (optional) Example: 192.168.1.2/24
アクセスを許可するIPアドレス。IPv4・CIDR形式のIPv4をひとつだけ指定できます。省略時はIPアドレス制限を行いません。
format: string (optional) Example: flat
テキスト化ファイルの形式。json・flat・csv・tsvのいずれか。省略時はflat（事業者の音声認識設定に従う）。

番号使用状況 ¶

搭載された番号帯別の利用状況を取得します。

番号使用状況取得 ¶

GET https://api.calltracker.jp/ct/3.0a/phonenums/12345678901234567890abcd

Responses200400401403404406409500

Headers

Content-Type: application/json

Body

{
  "result": {
    "phonenums": {
      "prefix": "050",
      "demandkey": "demand050",
      "contract_num": 20,
      "active_num": 10,
      "expiryclose_num": 5,
      "stock_num": 10
    }
  },
  "trn_id": "570315a53e3f8b166d12945c",
  "trn_tms": "2015-06-25T18:17:24+09:00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "result": {
      "type": "object",
      "properties": {
        "phonenums": {
          "type": "object",
          "properties": {
            "prefix": {
              "type": "string",
              "description": "番号帯種別。"
            },
            "demandkey": {
              "type": "string",
              "description": "発番キー。"
            },
            "contract_num": {
              "type": "number",
              "description": "総契約番号数。"
            },
            "active_num": {
              "type": "number",
              "description": "発番済番号数。現在利用中の番号数。"
            },
            "expiryclose_num": {
              "type": "number",
              "description": "有効期限間近番号数。発番済番号のうち、1週間以内に有効期限を迎える番号数。"
            },
            "stock_num": {
              "type": "number",
              "description": "在庫数。発番可能な残番号数。"
            }
          },
          "required": [
            "prefix",
            "demandkey",
            "contract_num",
            "active_num",
            "expiryclose_num",
            "stock_num"
          ]
        }
      },
      "required": [
        "phonenums"
      ],
      "description": "APIの実行結果。"
    },
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "trn_tms": {
      "type": "string",
      "description": "処理成功日時。"
    }
  },
  "required": [
    "result",
    "trn_id",
    "trn_tms"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

Headers

Content-Type: application/json

Body

{
  "trn_id": "570315a53e3f8b166d12945c",
  "err_tms": "2015-06-25T18:17:24+09:00",
  "code": "APID-*-***-*****",
  "message": "メッセージ内容"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "trn_id": {
      "type": "string",
      "description": "実行結果の処理ID。"
    },
    "err_tms": {
      "type": "string",
      "description": "エラー発生日時。"
    },
    "code": {
      "type": "string",
      "description": "エラーコード。"
    },
    "message": {
      "type": "string",
      "description": "エラーメッセージ。"
    }
  },
  "required": [
    "trn_id",
    "err_tms",
    "code",
    "message"
  ]
}

番号使用状況取得
GET`/phonenums/{partner}`

搭載された利用状況を取得します。
番号帯別に、総数・発番済番号数・有効期限間近(1週間以内)の番号数・在庫数を取得できます。

URI Parameters

HideShow

partner: string (required) Example: 12345678901234567890abcd
事業者ID

Generated by aglio on 08 Apr 2026

API Endpoint

通信方式 ¶

ユーザー認証方式 ¶

・Basic認証 ¶

・Cookieセッション認証 ¶

・Bearerトークン ¶

IPアドレス制限 ¶

リクエストパラメータの形式 ¶

レスポンスの形式 ¶

ステータスコード ¶

REST APIに対応できない場合 ¶

・HTTPメソッドをGETまたはPOST以外に設定できない場合 ¶

・APIの応答書式を指定する、HTTPヘッダ「Accept」または「X-COMSQAPI-Response-Type: (MIME-Type)」と指定できない場合 ¶

・APIの応答について、異常時に200～399以外の応答が返戻されると問題がある場合 ¶

その他 ¶

各リソースの編集・削除・取得に関する制限 ¶

認証 ¶

ログイン認証 ¶

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

ログイン認証POST/uauth/login/{partner}

ログアウト ¶

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

ログアウトGET/uauth/logout/{partner}

認証トークン発行 ¶

Headers

Body

Schema

Headers

Body

Schema

Headers

通信方式

ユーザー認証方式

・Basic認証

・Cookieセッション認証

・Bearerトークン

IPアドレス制限

リクエストパラメータの形式

レスポンスの形式

ステータスコード

REST APIに対応できない場合

・HTTPメソッドをGETまたはPOST以外に設定できない場合

・APIの応答書式を指定する、HTTPヘッダ「Accept」または「X-COMSQAPI-Response-Type: (MIME-Type)」と指定できない場合

・APIの応答について、異常時に200～399以外の応答が返戻されると問題がある場合

その他

各リソースの編集・削除・取得に関する制限

ログイン認証
POST`/uauth/login/{partner}`

ログアウト
GET`/uauth/logout/{partner}`

認証トークン発行
POST`/uauth/token/{partner}`

認証トークンリフレッシュ
POST`/uauth/token_refresh/{partner}`