こちらの API は廃止されています。
最新のAPIドキュメントは、developers.dialpad.com/docs/welcome を参照ください。
API に関する質問は developer discussion board をご覧ください。
本APIを利用することによりユーザーの管理を自動化することが可能です。すべてのAPIへのアクセスはシンプルなHTTP RESTベースとなっています。
すべてのHTTPによるリクエストは、カンパニー管理者に発行されるアクセストークンによりアクセスが可能です。api_keyもしくはAuthorization: Bearer HTTPヘッダー(例: Authorization: Bearer <access_token>)を付けることによりアクセストークンをパスすることが可能です。
GET Request
https://dialpad.com/api/v1/admin/user?email=adam@example.com&action=add&first_name=Adam
基本的なユーザー管理
新規ユーザーの追加
本APIではユーザーの追加はドメインに対して行われ、特定のオフィスを指定することは出来ません。特定のオフィスにユーザーを追加したい場合、Dialpad管理コンソールにて行ってください。
- 移行先のオフィスに十分なライセンスが割当たっていることを確認してください(足りない場合アラートが表示されます)
- 実行する管理者は、ターゲットとなるユーザーへのアクセス権限だけでなくオフィスの管理者権限も所有していることを確認してください
Dialpad Tip: 全てのライセンスは例え利用されていなくても課金されるので注意してください。もしライセンス自体を解約したい場合、弊社サポートまでご連絡ください。
| limit | ユーザー数 |
| cursor | 次のユーザーリストへのカーソル。最初にリクエストしたユーザーリストのユーザー数よりも多くユーザーが存在する場合、カーソルが返されます。この値をパラメータとしてパスするとユーザーリストの先頭行の値を返します。 |
オフィス情報
新規に作成したユーザーを特定のオフィスにアサインしたい場合、office_keyパラメータに対して、上述の値をkey値として設定してください。
| パラメータ | 設定値 | 必須 | 説明 |
| office_key | (ドメインに対し各オフィスに一意の値) | オプション |
ユーザーをオフィスにアサインする場合使用します(最初にユーザーを追加するときのみ) |
| action | add | delete | suspend | reactivate | オプション |
メールアドレス(ユーザー)に対して実行注: 停止(suspend)したユーザーはログインと通話、チャットができなくなります。 その他のすべてのデータ(データリテンション含む)は、引き続き保持されます。停止したアカウントにも課金は発生します。 |
| 必須 |
対象となるアカウントのメールアドレス。 |
||
| first_name | オプション |
ユーザーの名前 |
|
| last_name | オプション |
ユーザーの名字 |
レスポンス
以下のような結果が返されます:
アナリティクス
GET Request
/api/v1/admin/stats
最初のリクエストに対して以下のようなステータスもしくはレコードが返されます:
{"kind": "stats","status": "processing"}
フォローアップのリクエストに対して処理が完了するまで数分かかるような場合、”processing”というメッセージが返されます。準備が完了した場合、以下のようなCSVダウンロードリンクを含む値が返されます。
{"download_url": "<url>", "file_type": "csv","kind": "stats","status": "complete"}
パラメータ
| stat_type | 必須 |
"calls" もしくは "texts" |
| target | オプション |
特定のユーザーもしくはグループのアナリティクス情報を取得したい場合指定します。 |
| is_company | オプション |
カンパニー全体の統計情報を取得したい場合、こちらを指定します。 |
| office_id | オプション |
オフィスのID 注: targetを指定しなかった場合、is_companyもしくはoffice_idがデフォルトのオフィス値として採用されます。 |
| export_type |
"stats"もしくは"records" |
|
| days_ago_start |
(データ採取)開始日 例: 1=昨日(yesterday) |
|
| days_ago_end |
(データ採取)終了日 例: 1を指定した場合昨日(yesterday)を表します。開始日を1、終了日を2と指定した場合、2日前から昨日までを期間として指定することになります。 |