管理者API

APIアクセスは現在Enterpriseプランのみとなっております。(日本未対応)

本機能は現在オプションとなっております。

本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

基本的なユーザー管理

新規ユーザーの追加

POST Request
 
/api/v1/admin/user
 
パラメータ:
 
email=adam@example.com&first_name=Adam&last_name=Johnson

本APIではユーザーの追加はドメインに対して行われ、特定のオフィスを指定することは出来ません。特定のオフィスにユーザーを追加したい場合、Dialpad管理コンソールにて行ってください。
 
ユーザー電話番号の追加
 
POST Request
 
/api/v1/admin/did
 
パラメータ:
 
target_key=<target_key>
 
本APIではデスクフォンもしくはオフィスではなくユーザーへ電話番号を追加します。target_keyへアクセスするには、管理者にて/userをコールしてユーザーキーを取得し、それをtarget_keyとしてパスします。
 
ユーザー電話番号の削除
 
DELETE Request
 
/api/v1/admin/did
 
パラメータ:
 
target_key=<target_key>
 
ユーザーに属しているすべての電話番号を削除します。target_keyは/userに対するGETリクエストに含まれます。
 
他のオフィスへのユーザーの移行
 
PUT Request
 
/api/v1/admin/user
 
パラメータ:
 
target_key=<target_key>&office_key=<office_key>
 
本APIではユーザーを他のオフィスに移す場合に利用します。office_keyは/office APIをコールすることにより得ることができます。
 
インターナショナルオフィス(海外オフィスを含む)の場合、一旦ユーザーから電話番号を削除します。移行完了後、管理者によりPOSTリクエスト経由で/didに電話番号を追加します。
 
API利用時に以下の点を確認してください:
  • 移行先のオフィスに十分なライセンスが割当たっていることを確認してください(足りない場合アラートが表示されます)

  • 実行する管理者は、ターゲットとなるユーザーへのアクセス権限だけでなくオフィスの管理者権限も所有していることを確認してください

Dialpad Tip: 全てのライセンスは例え利用されていなくても課金されるので注意してください。もしライセンス自体を解約したい場合、弊社サポートまでご連絡ください。

ユーザー情報の取得
 
GET Request
 
/api/v1/admin/user
 
パラメータ:
 
email=adam@example.com
 
ユーザーリストの取得
 
GET Request
 
/api/v1/admin/user
 
パラメータオプション:
 
limit ユーザー数
cursor 次のユーザーリストへのカーソル。最初にリクエストしたユーザーリストのユーザー数よりも多くユーザーが存在する場合、カーソルが返されます。この値をパラメータとしてパスするとユーザーリストの先頭行の値を返します。
 
 
 
ユーザーの停止
 
PUT Request
 
/api/v1/admin/user
 
パラメータ:
 
email=crookedemployee@example.com&action=suspend
  
ユーザーの削除
 
DELETE Request
 
/api/v1/admin/user
 
パラメータ:
 
email=bademployee

オフィス情報

GET Request
 
/api/v1/admin/office
 
ドメイン内の全てのオフィスをリストします。全てのエントリーは各オフィスごとの一意の値をキーパラメータとして含みます。 

新規に作成したユーザーを特定のオフィスにアサインしたい場合、office_keyパラメータに対して、上述の値をkey値として設定してください。

https://dialpad.com/api/v1/admin/user?office_key<office_key>&email=alice@example.com&action=add&api_key=<api_key> 

パラメータ
 
パラメータ 設定値 必須 説明
office_key (ドメインに対し各オフィスに一意の値) オプション

ユーザーをオフィスにアサインする場合使用します(最初にユーザーを追加するときのみ)

action add | delete | suspend | reactivate オプション

メールアドレス(ユーザー)に対して実行注: 停止(suspend)したユーザーはログインと通話、チャットができなくなります。 その他のすべてのデータ(データリテンション含む)は、引き続き保持されます。停止したアカウントにも課金は発生します。

 email   必須

対象となるアカウントのメールアドレス。

first_name   オプション

ユーザーの名前

last_name   オプション

ユーザーの名字

レスポンス

HTTPリクエストの結果としてJSON blobが返されます。例えば以下のようなリクエストの場合:
 
POST https://dialpad.com/api/v1/admin/user?email=sample@sample.com

 以下のような結果が返されます: 

{
    "office_count": 34,
    "pending_user": "sample@sample.com",
    "message": "creating user...check back in a moment please",
    # Adding a new user is asynchronous. Check the user status later.
    "company_count": 34
}
 
アクションパラメータが指定されない場合、以下のようなユーザーのステータスが返されます。
 
{
    # Company account information
    office_count: 34,
    company_count: 34,
    # User information
    user: {
        last_name: "",
        first_name: "",
        primary_email: "sample@sample.com",
        primary_phone: "+14154292691",
        # ... etc
    }
}
 
もしユーザーが存在しない場合、ユーザーキーは返されず、ただカンパニーアカウント情報が返されます。
 
リクエストが何らかの理由で受け付けられなかった場合、HTTPエラーコード400番代もしくは500番代が以下のようなJSONとともに返されます。
 
{
    status: 1,
    errors: [
        "email_conflict"
    ]
}

アナリティクス

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日前から昨日までを期間として指定することになります。  


ベリフィケーション 

Dialpad.com/accountsをクリックし、すべてのアカウントが追加されていることを確認します。テスト目的として確認する場合、Chromeブラウザでインコグニートモードを利用することをお勧めします。