Zvanu Parvaldnieks (プレビュー)
Zvanu Parvaldnieks は、LMT モバイル加入者向けのモバイル仮想 PBX サービスです。 このコネクタを使用すると、ユーザーは、通話、ボイスメール、連絡先、および構成に関するすべてのデータとイベントを他のサービスに簡単に送信できます。
このコネクタは、次の製品および地域で利用可能です:
Service | クラス | 地域 |
---|---|---|
Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
お問い合わせ先 | |
---|---|
件名 | Latvijas Mobilais Telefons |
[URL] | https://zvanuparvaldnieks.lmt.lv |
メール | tehn.atbalsts@lmt.lv |
Connector Metadata | |
---|---|
発行者 | Latvijas Mobilais Telefons |
Web サイト | https://zvanuparvaldnieks.lmt.lv |
プライバシー ポリシー | https://www.lmt.lv/en/data-processing |
カテゴリー | 通信;IT 操作 |
Zvanu Parvaldnieks は、LMT モバイル加入者向けのモバイル仮想 PBX サービスです。 このコネクタを使用すると、ユーザーは、通話、ボイスメール、連絡先、および構成に関するすべてのデータとイベントを他のサービスに簡単に送信できます。
前提条件
続行するには、次のものが必要です。
- LMT Zvanu parvaldnieks サブスクリプションの電話番号
- https://zvanuparvaldnieks.lmt.lv/integration で生成できる API キー
資格情報の入手方法
https://zvanuparvaldnieks.lmt.lv/integration で生成された API キーをベアラー トークンとして使用します。
Bearer OnYSrLTH3i2qiyb873au2LNdAajXjf5I
コネクタの使用を開始する
- 新しい API キーを作成
- IP が変更されたら IP ACL を
0.0.0.0/0
として追加 - Microsoft Power Automate で使用する必要のあるすべての API メソッドを追加
既知の問題と制限事項
- 同時に作成できる Webhook は 20 個までなので、トリガーで問題が発生した場合は、Zvanu parvaldnieks パネルの [API]->[WEBHOOK] で Webhook の数を確認してください
- アイテムは
Get <anything>
トリガーと一緒に集められません。新しく作成されたアイテムのみがトリガーとともに収集されることに注意してください。 - 認証の問題 - API キーを
Bearer <api_key>
の形式で構成してください
一般的なエラーと解決策
403 Webhook の制限に達しました
同時に作成できる Webhook は 20 個までなので、トリガーで問題が発生した場合は、Zvanu parvaldnieks パネルの [API]->[WEBHOOK] で Webhook の数を確認してください
404 項目が見つかりません
リクエストに基づくアイテムは見つかりませんでした。 アイテムが存在することを確認し、正しく入力されているかどうかフィルター フィールドを確認してください。
422 処理できなかったエンティティ
フィルター値が正しく入力されているかどうかを確認してください。
よくあるご質問
このコネクタを使用するメリットは何ですか。
API からデータを収集するソリューションを自分で開発する通常のシナリオとは異なり、このコネクタは、ソース (Zvanu parvaldnieks API となります) とデータが送信される宛先の間の中間ステップをすでに提供しています。 たとえば、CallConnected
トリガーでフローを構成することによって、応答したすべての通話に関する情報を直接 OneDrive Excel シートに送信できます。
このコネクタの使用を開始するための要件は何ですか。
あなたは LMT キャリア加入者であると同時に Zvanu parvaldnieks サービスの加入者である必要があります。
Webhook コールバックと通常の Get
操作の違いは何ですか。
Get
操作は、特定のタイプのアイテムのリストを維持します。たとえば、Get call History
で呼び出すと、毎回、新しく作成された通話履歴アイテムのみを収集します。 ただし、Webhook コールバックは、新しいイベントが受信されると、Zvanu parvaldnieks サービス側から自動的にトリガーされます。 たとえば、新しいボイスメール メッセージが残されると、Zvanu parvaldnieks は新しいボイスメール メッセージに関するデータを含むイベントをコネクタに送信します。
接続を作成する
このコネクタは、次の認証タイプをサポートしています:
既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
件名 | タイプ | 内容 | 必要 |
---|---|---|---|
API キー | securestring | この API の API キー | True |
調整制限
名前 | 呼び出し | 更新期間 |
---|---|---|
接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
ID で VoIP エンドポイントを取得 |
ID を指定して、単一のVoIP エンドポイント オブジェクトを取得します。 |
ID でグループを取得 |
ID を指定して、単一の従業員グループ オブジェクトを取得します。 |
ID でボイスメール ボックスを取得 |
ID を指定して、単一のボイスメール ボックス オブジェクトを取得します。 |
ID でボイスメールを取得 |
ID を指定して、単一のボイスメール オブジェクトを取得します。 |
ID で取引先担当者を取得 |
ID を指定して、単一の従業員オブジェクトを取得します。 |
ID で通話履歴アイテムを取得する |
ID を指定して、単一の通話履歴エントリを取得します。 |
ID で通話録音を取得 |
ID を指定して、単一の通話録音を取得します。 |
ID で音声プロンプトを取得 |
ID を指定して、単一のオーディオ プロンプト オブジェクトを取得します。 |
呼損を取得 |
応答されていない、コールバックされてた、または発信者が同じ日に繰り返し試行しても従業員に到達していない通話履歴から、呼損録音をすべて取得します。 |
発信 |
デバイスにリクエストを送信して、新しい通話の開始をリクエストします。 |
ID で VoIP エンドポイントを取得
ID を指定して、単一のVoIP エンドポイント オブジェクトを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
VoIP エンドポイント ID
|
endpoint_id | True | integer |
VoIP エンドポイントの一意の ID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
version
|
version | string |
version |
status
|
status | string |
status |
statusCode
|
statusCode | integer |
statusCode |
message
|
message | string |
message |
id
|
data.id | integer |
id |
name
|
data.name | string |
name |
employee_id
|
data.employee_id | integer |
employee_id |
ID でグループを取得
ID を指定して、単一の従業員グループ オブジェクトを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
グループ ID
|
group_id | True | integer |
従業員グループの一意の ID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
version
|
version | string |
version |
status
|
status | string |
status |
statusCode
|
statusCode | integer |
statusCode |
message
|
message | string |
message |
Created
|
data.created | date-time |
created |
groupID
|
data.groupID | integer |
groupID |
type
|
data.type | integer |
type |
name
|
data.name | string |
name |
members
|
data.members | array of object |
members |
contactID
|
data.members.contactID | integer |
contactID |
ID でボイスメール ボックスを取得
ID を指定して、単一のボイスメール ボックス オブジェクトを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ボイスメール ボックス ID
|
box_id | True | integer |
ボイスメール ボックスの一意の ID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
version
|
version | string |
version |
status
|
status | string |
status |
statusCode
|
statusCode | integer |
statusCode |
message
|
message | string |
message |
clientID
|
data.clientID | integer |
clientID |
boxName
|
data.boxName | string |
boxName |
created
|
data.created | string |
created |
voicemailBoxID
|
data.voicemailBoxID | integer |
voicemailBoxID |
ID でボイスメールを取得
ID を指定して、単一のボイスメール オブジェクトを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ボイスメール ID
|
voicemail_id | True | integer |
ボイスメールの一意の ID です。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
version
|
version | string |
version |
status
|
status | string |
status |
statusCode
|
statusCode | integer |
statusCode |
message
|
message | string |
message |
sender
|
data.sender | string |
sender |
voicemailID
|
data.voicemailID | integer |
voicemailID |
length
|
data.length | integer |
length |
callStarted
|
data.callStarted | string |
callStarted |
voicemailBoxID
|
data.voicemailBoxID | integer |
voicemailBoxID |
voicemailBoxName
|
data.voicemailBoxName | string |
voicemailBoxName |
messageURL
|
data.messageURL | string |
messageURL |
ID で取引先担当者を取得
ID を指定して、単一の従業員オブジェクトを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
連絡先 ID
|
contact_id | True | integer |
従業員の一意の ID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
version
|
version | string |
version |
status
|
status | string |
status |
statusCode
|
statusCode | integer |
statusCode |
message
|
message | string |
message |
current_callerid
|
data.current_callerid | string |
current_callerid |
archived
|
data.archived | integer |
archived |
firstname
|
data.firstname | string |
firstname |
lastname
|
data.lastname | string |
lastname |
created
|
data.created | string |
created |
number
|
data.number | string |
number |
contactID
|
data.contactID | integer |
contactID |
group_membership
|
data.group_membership | array of object |
group_membership |
created
|
data.group_membership.created | string |
created |
groupID
|
data.group_membership.groupID | integer |
groupID |
type
|
data.group_membership.type | integer |
type |
name
|
data.group_membership.name | string |
name |
members
|
data.group_membership.members | array of object |
members |
contactID
|
data.group_membership.members.contactID | integer |
contactID |
avatar
|
data.avatar | string |
avatar |
ID で通話履歴アイテムを取得する
ID を指定して、単一の通話履歴エントリを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
通話 ID
|
call_id | True | integer |
呼び出しの一意の ID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
version
|
version | string |
version |
ステータス
|
status | string |
ステータス |
statusCode
|
statusCode | integer |
statusCode |
message
|
message | string |
message |
callID
|
data.callID | integer |
callID |
caller
|
data.caller | string |
caller |
destination
|
data.destination | string |
destination |
direction
|
data.direction | string |
direction |
status
|
data.status | integer |
status |
callStarted
|
data.callStarted | string |
callStarted |
callConnected
|
data.callConnected | string |
callConnected |
callEnded
|
data.callEnded | string |
callEnded |
connectionTime
|
data.connectionTime | integer |
connectionTime |
contactID
|
data.contactID | integer |
contactID |
recordingID
|
data.recordingID | integer |
recordingID |
ID で通話録音を取得
ID を指定して、単一の通話録音を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
録音 ID
|
record_id | True | integer |
録音の一意の ID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
version
|
version | string |
version |
status
|
status | string |
status |
statusCode
|
statusCode | integer |
statusCode |
message
|
message | string |
message |
recordingID
|
data.recordingID | integer |
recordingID |
callID
|
data.callID | integer |
callID |
caller
|
data.caller | string |
caller |
destination
|
data.destination | string |
destination |
direction
|
data.direction | string |
direction |
status
|
data.status | integer |
status |
callStarted
|
data.callStarted | string |
callStarted |
callConnected
|
data.callConnected | string |
callConnected |
callEnded
|
data.callEnded | string |
callEnded |
contactID
|
data.contactID | integer |
contactID |
recordingURL
|
data.recordingURL | string |
recordingURL |
ID で音声プロンプトを取得
ID を指定して、単一のオーディオ プロンプト オブジェクトを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
音声プロンプト ID
|
prompt_id | True | integer |
オーディオ プロンプトの一意の ID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
version
|
version | string |
version |
status
|
status | string |
status |
statusCode
|
statusCode | integer |
statusCode |
message
|
message | string |
message |
id
|
data.id | integer |
id |
name
|
data.name | string |
name |
type
|
data.type | integer |
type |
呼損を取得
応答されていない、コールバックされてた、または発信者が同じ日に繰り返し試行しても従業員に到達していない通話履歴から、呼損録音をすべて取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
制限
|
limit | integer |
取得する結果の数を制限します。 |
|
オフセット
|
offset | integer |
データを取得する結果を指定するために使用されます。 |
|
宛先
|
destination | string |
通話先の番号。 |
|
開始日
|
date_from | date-time |
フィルタリングされた日付範囲の開始日。 |
|
終了日
|
date_to | date-time |
フィルタリングされた日付範囲の終了日。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
version
|
version | string |
version |
status
|
status | string |
status |
statusCode
|
statusCode | integer |
statusCode |
message
|
message | string |
message |
data
|
data | array of object |
data |
contact_name
|
data.contact_name | string |
contact_name |
destination
|
data.destination | string |
destination |
attempts
|
data.attempts | integer |
attempts |
callerid
|
data.callerid | string |
callerid |
最終連絡
|
data.last_contact | date-time |
last_contact |
発信
デバイスにリクエストを送信して、新しい通話の開始をリクエストします。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
宛先
|
destination | True | string |
宛先番号。 |
取引先担当者 ID
|
contactID | True | integer |
従業員の一意の ID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
version
|
version | string |
version |
status
|
status | string |
status |
statusCode
|
statusCode | integer |
statusCode |
message
|
message | string |
message |
トリガー
Call |
通話が終了した瞬間にイベント CallCompletedEvent を受信すると、通話に関するデータ ペイロードをイベントに提供します。 |
Call |
通話に応答した瞬間にイベント CallConnectedEvent を受信すると、通話に関するデータ ペイロードをイベントに提供します。 |
Call |
録音が作成された瞬間に CallRecorded イベントを受信すると、通話に関するデータ ペイロードをイベントに提供します。 |
Call |
通話が開始したときにイベント CallStarted を受信すると、通話に関するデータ ペイロードをイベントに提供します。 |
Call |
在席転送のブラインド転送によって通話がサードパーティに転送された瞬間に CallTransfered イベントを受け取ると、通話に関するデータ ペイロードをイベントに提供します。 |
Lost |
通話に応答がなく、呼損として登録された瞬間に LostCallerCreated イベントを受け取ると、通話に関するデータ ペイロード データをイベントに提供します。 |
Lost |
呼損が従業員からコールバックされたとき、または同じ発信元からの繰り返し発信において後で応答されたときに LostCallerDeleted イベントを受け取ると、通話に関するデータ ペイロードをイベントに提供します。 |
Lost |
同じ番号から別の失敗した通話試行を受け取ったため、呼損記録の試行と last_contact フィールドが新しい番号とタイムスタンプで更新された瞬間に、LostCallerUpdated イベントを受け取ると、通話に関するデータ ペイロード データをイベントに提供します。 |
Voicemail |
発信者がボイスメールを残した瞬間に VoicemailCreated イベントを受け取ると、ボイスメールに関するデータ ペイロードをイベントに提供します。 |
Voicemail |
ユーザーがボイスメールを削除した瞬間に VoicemailDeleted イベントを受け取ると、ボイスメールに関するデータ ペイロードをイベントに提供します。 |
VoIP エンドポイントを取得 |
VoIP エンドポイントエントリを取得します。 |
グループの取得 |
従業員グループのデータを取得します。 さらに、API コンシューマーは、contact_id に基づいて返されたレコードをフィルター処理し、特定の従業員をメンバーとして持つグループのみに結果を制限することができます。 |
ボイスメール ボックスを取得 |
作成されたボイスメール ボックスのリストを取得します。 |
ボイスメールを取得 |
ボイスメール メッセージを取得します。 さらに、API コンシューマーは、contact_id、source、box_id、または date_range に基づいて返されたレコードをフィルター処理し、特定の従業員、ボイスメール ボックス、特定の番号、または要求された日付範囲内に残されたメッセージのみに結果を制限できます。 |
取引先担当者を取得 |
新しい従業員が作成されたときにトリガーされます |
通話履歴を取得 |
通話履歴エントリを取得します。 さらに、API コンシューマーは、通話に関与する特定の番号または従業員 (source、destination、または contact_id) に基づいて返されたレコードをフィルター処理できるだけでなく、方向に基づいて着信または発信呼び出しのみフィルターで除外したり、指定された日付範囲 (date_range) 内で行われた呼び出しのみをフィルターで除外したりできます。 |
通話記録を取得 |
通話録音を取得します。 さらに、API コンシューマーは、通話に関与する特定の番号または従業員 (source、destination、または contact_id) に基づいて返されたレコードをフィルター処理できるだけでなく、方向に基づいて着信または発信呼び出しのみフィルターで除外したり、指定された日付範囲 (date_range) 内で行われた呼び出しのみをフィルターで除外したりできます。 |
音声プロンプトを取得 |
音声プロンプト エントリを取得します。 |
CallCompleted Webhook コールバック
通話が終了した瞬間にイベント CallCompletedEvent を受信すると、通話に関するデータ ペイロードをイベントに提供します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
type
|
type | string |
type |
version
|
version | string |
version |
eventType
|
eventType | string |
eventType |
callID
|
data.callID | integer |
callID |
caller
|
data.caller | string |
caller |
destination
|
data.destination | string |
destination |
direction
|
data.direction | string |
direction |
status
|
data.status | integer |
status |
callStarted
|
data.callStarted | string |
callStarted |
callConnected
|
data.callConnected | string |
callConnected |
connectionTime
|
data.connectionTime | integer |
connectionTime |
contactID
|
data.contactID | integer |
contactID |
previous_contactID
|
data.previous_contactID | integer |
previous_contactID |
CallConnected Webhook コールバック
通話に応答した瞬間にイベント CallConnectedEvent を受信すると、通話に関するデータ ペイロードをイベントに提供します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
type
|
type | string |
type |
version
|
version | string |
version |
eventType
|
eventType | string |
eventType |
callID
|
data.callID | integer |
callID |
caller
|
data.caller | string |
caller |
destination
|
data.destination | string |
destination |
direction
|
data.direction | string |
direction |
status
|
data.status | integer |
status |
callStarted
|
data.callStarted | string |
callStarted |
callConnected
|
data.callConnected | string |
callConnected |
contactID
|
data.contactID | integer |
contactID |
CallRecorded Webhook コールバック
録音が作成された瞬間に CallRecorded イベントを受信すると、通話に関するデータ ペイロードをイベントに提供します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
type
|
type | string |
type |
version
|
version | string |
version |
eventType
|
eventType | string |
eventType |
recordingID
|
data.recordingID | integer |
recordingID |
callID
|
data.callID | integer |
callID |
callStarted
|
data.callStarted | string |
callStarted |
recordingURL
|
data.recordingURL | string |
recordingURL |
direction
|
data.direction | string |
direction |
connectionTime
|
data.connectionTime | integer |
connectionTime |
CallStarted Webhook コールバック
通話が開始したときにイベント CallStarted を受信すると、通話に関するデータ ペイロードをイベントに提供します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
type
|
type | string |
type |
version
|
version | string |
version |
eventType
|
eventType | string |
eventType |
callID
|
data.callID | integer |
callID |
caller
|
data.caller | string |
caller |
destination
|
data.destination | string |
destination |
direction
|
data.direction | string |
direction |
status
|
data.status | integer |
status |
callStarted
|
data.callStarted | string |
callStarted |
contactID
|
data.contactID | integer |
contactID |
CallTransfered Webhook コールバック
在席転送のブラインド転送によって通話がサードパーティに転送された瞬間に CallTransfered イベントを受け取ると、通話に関するデータ ペイロードをイベントに提供します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
type
|
type | string |
type |
version
|
version | string |
version |
eventType
|
eventType | string |
eventType |
callID
|
data.callID | integer |
callID |
caller
|
data.caller | string |
caller |
destination
|
data.destination | string |
destination |
status
|
data.status | integer |
status |
callStarted
|
data.callStarted | string |
callStarted |
callConnected
|
data.callConnected | string |
callConnected |
connectionTime
|
data.connectionTime | integer |
connectionTime |
contactID
|
data.contactID | integer |
contactID |
previous_contactID
|
data.previous_contactID | integer |
previous_contactID |
direction
|
data.direction | string |
direction |
LostCallerAdded Webhook コールバック
通話に応答がなく、呼損として登録された瞬間に LostCallerCreated イベントを受け取ると、通話に関するデータ ペイロード データをイベントに提供します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
type
|
type | string |
type |
version
|
version | string |
version |
eventType
|
eventType | string |
eventType |
contact_name
|
data.contact_name | string |
contact_name |
destination
|
data.destination | string |
destination |
attempts
|
data.attempts | integer |
attempts |
callerid
|
data.callerid | string |
callerid |
last_contact
|
data.last_contact | string |
last_contact |
LostCallerRemoved Webhook コールバック
呼損が従業員からコールバックされたとき、または同じ発信元からの繰り返し発信において後で応答されたときに LostCallerDeleted イベントを受け取ると、通話に関するデータ ペイロードをイベントに提供します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
type
|
type | string |
type |
version
|
version | string |
version |
eventType
|
eventType | string |
eventType |
destination
|
data.destination | string |
destination |
callerid
|
data.callerid | string |
callerid |
LostCallerUpdated Webhook コールバック
同じ番号から別の失敗した通話試行を受け取ったため、呼損記録の試行と last_contact フィールドが新しい番号とタイムスタンプで更新された瞬間に、LostCallerUpdated イベントを受け取ると、通話に関するデータ ペイロード データをイベントに提供します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
type
|
type | string |
type |
version
|
version | string |
version |
eventType
|
eventType | string |
eventType |
contact_name
|
data.contact_name | string |
contact_name |
destination
|
data.destination | string |
destination |
attempts
|
data.attempts | integer |
attempts |
callerid
|
data.callerid | string |
callerid |
last_contact
|
data.last_contact | string |
last_contact |
VoicemailCreated Webhook コールバック
発信者がボイスメールを残した瞬間に VoicemailCreated イベントを受け取ると、ボイスメールに関するデータ ペイロードをイベントに提供します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
type
|
type | string |
type |
version
|
version | string |
version |
eventType
|
eventType | string |
eventType |
sender
|
data.sender | string |
sender |
voicemailID
|
data.voicemailID | integer |
voicemailID |
length
|
data.length | integer |
length |
callStarted
|
data.callStarted | string |
callStarted |
voicemailBoxID
|
data.voicemailBoxID | integer |
voicemailBoxID |
voicemailBoxName
|
data.voicemailBoxName | string |
voicemailBoxName |
messageURL
|
data.messageURL | string |
messageURL |
VoicemailDeleted Webhook コールバック
ユーザーがボイスメールを削除した瞬間に VoicemailDeleted イベントを受け取ると、ボイスメールに関するデータ ペイロードをイベントに提供します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
type
|
type | string |
type |
version
|
version | string |
version |
eventType
|
eventType | string |
eventType |
sender
|
data.sender | string |
sender |
voicemailID
|
data.voicemailID | integer |
voicemailID |
VoIP エンドポイントを取得
VoIP エンドポイントエントリを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
VoIP エンドポイント ID
|
endpoint_id | integer |
VoIP エンドポイントの一意の ID。 |
|
制限
|
limit | integer |
取得する結果の数を制限します。 |
|
オフセット
|
offset | integer |
データを取得する結果を指定するために使用されます。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
version
|
version | string |
version |
status
|
status | string |
status |
statusCode
|
statusCode | integer |
statusCode |
message
|
message | string |
message |
data
|
data | array of object |
data |
id
|
data.id | integer |
id |
name
|
data.name | string |
name |
employee_id
|
data.employee_id | integer |
employee_id |
グループの取得
従業員グループのデータを取得します。 さらに、API コンシューマーは、contact_id に基づいて返されたレコードをフィルター処理し、特定の従業員をメンバーとして持つグループのみに結果を制限することができます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
グループ ID
|
group_id | integer |
グループを表す一意の ID。 |
|
連絡先 ID
|
contact_id | integer |
従業員の一意の ID。 |
|
制限
|
limit | integer |
取得する結果の数を制限します。 |
|
オフセット
|
offset | integer |
データを取得する結果を指定するために使用されます。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
version
|
version | string |
version |
status
|
status | string |
status |
statusCode
|
statusCode | integer |
statusCode |
message
|
message | string |
message |
data
|
data | array of object |
data |
created
|
data.created | string |
created |
groupID
|
data.groupID | integer |
groupID |
type
|
data.type | integer |
type |
name
|
data.name | string |
name |
members
|
data.members | array of object |
members |
contactID
|
data.members.contactID | integer |
contactID |
ボイスメール ボックスを取得
作成されたボイスメール ボックスのリストを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ボイスメール ボックス ID
|
box_id | integer |
ボイスメール ボックスの一意の ID。 |
|
制限
|
limit | integer |
取得する結果の数を制限します。 |
|
オフセット
|
offset | integer |
データを取得する結果を指定するために使用されます。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
version
|
version | string |
version |
status
|
status | string |
status |
statusCode
|
statusCode | integer |
statusCode |
message
|
message | string |
message |
data
|
data | array of object |
data |
clientID
|
data.clientID | integer |
clientID |
boxName
|
data.boxName | string |
boxName |
created
|
data.created | string |
created |
voicemailBoxID
|
data.voicemailBoxID | integer |
voicemailBoxID |
ボイスメールを取得
ボイスメール メッセージを取得します。 さらに、API コンシューマーは、contact_id、source、box_id、または date_range に基づいて返されたレコードをフィルター処理し、特定の従業員、ボイスメール ボックス、特定の番号、または要求された日付範囲内に残されたメッセージのみに結果を制限できます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ボイスメール ID
|
voicemail_id | integer |
ボイスメール メッセージの一意の ID。 |
|
制限
|
limit | integer |
取得する結果の数を制限します。 |
|
オフセット
|
offset | integer |
データを取得する結果を指定するために使用されます。 |
|
ソース電話番号
|
source | string |
発信元関係者の番号。 |
|
連絡先 ID
|
contact_id | integer |
従業員の一意の ID。 |
|
ボイスメール ボックス ID
|
box_id | integer |
ボイスメール ボックスの一意の ID。 |
|
開始日
|
date_from | date-time |
フィルタリングされた日付範囲の開始日。 |
|
終了日
|
date_to | date-time |
フィルタリングされた日付範囲の終了日。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
version
|
version | string |
version |
status
|
status | string |
status |
statusCode
|
statusCode | integer |
statusCode |
message
|
message | string |
message |
data
|
data | array of object |
data |
sender
|
data.sender | string |
sender |
voicemailID
|
data.voicemailID | integer |
voicemailID |
length
|
data.length | integer |
length |
callStarted
|
data.callStarted | string |
callStarted |
voicemailBoxID
|
data.voicemailBoxID | integer |
voicemailBoxID |
voicemailBoxName
|
data.voicemailBoxName | string |
voicemailBoxName |
messageURL
|
data.messageURL | string |
messageURL |
取引先担当者を取得
新しい従業員が作成されたときにトリガーされます
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
制限
|
limit | integer |
取得する結果の数を制限します。 |
|
オフセット
|
offset | integer |
データを取得する結果を指定するために使用されます。 |
|
連絡先 ID
|
contact_id | integer |
従業員の一意の ID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
version
|
version | string |
version |
status
|
status | string |
status |
statusCode
|
statusCode | integer |
statusCode |
message
|
message | string |
message |
data
|
data | array of object |
data |
current_callerid
|
data.current_callerid | string |
current_callerid |
archived
|
data.archived | integer |
archived |
firstname
|
data.firstname | string |
firstname |
lastname
|
data.lastname | string |
lastname |
created
|
data.created | string |
created |
number
|
data.number | string |
number |
contactID
|
data.contactID | integer |
contactID |
group_membership
|
data.group_membership | array of object |
group_membership |
created
|
data.group_membership.created | string |
created |
groupID
|
data.group_membership.groupID | integer |
groupID |
type
|
data.group_membership.type | integer |
type |
name
|
data.group_membership.name | string |
name |
members
|
data.group_membership.members | array of object |
members |
contactID
|
data.group_membership.members.contactID | integer |
contactID |
avatar
|
data.avatar | string |
avatar |
通話履歴を取得
通話履歴エントリを取得します。 さらに、API コンシューマーは、通話に関与する特定の番号または従業員 (source、destination、または contact_id) に基づいて返されたレコードをフィルター処理できるだけでなく、方向に基づいて着信または発信呼び出しのみフィルターで除外したり、指定された日付範囲 (date_range) 内で行われた呼び出しのみをフィルターで除外したりできます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
通話 ID
|
call_id | integer |
呼び出しの一意の ID。 |
|
制限
|
limit | integer |
取得する結果の数を制限します。 |
|
オフセット
|
offset | integer |
データを取得する結果を指定するために使用されます。 |
|
宛先番号
|
destination | string |
通話先の番号。 |
|
ソース電話番号
|
source | string |
発信元関係者の番号。 |
|
方向
|
direction | string |
通話が "着信" か "発信" かを示す "in" または "out"。 |
|
連絡先 ID
|
contact_id | integer |
通話に関与する従業員の一意 ID。 |
|
開始日
|
date_from | date-time |
フィルタリングされた日付範囲の開始日。 |
|
終了日
|
date_to | date-time |
フィルタリングされた日付範囲の終了日。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
version
|
version | string |
version |
status
|
status | string |
status |
statusCode
|
statusCode | integer |
statusCode |
message
|
message | string |
message |
data
|
data | array of object |
data |
callID
|
data.callID | integer |
callID |
caller
|
data.caller | string |
caller |
destination
|
data.destination | string |
destination |
direction
|
data.direction | string |
direction |
status
|
data.status | integer |
status |
callStarted
|
data.callStarted | string |
callStarted |
callConnected
|
data.callConnected | string |
callConnected |
callEnded
|
data.callEnded | string |
callEnded |
connectionTime
|
data.connectionTime | integer |
connectionTime |
contactID
|
data.contactID | integer |
contactID |
recordingID
|
data.recordingID | integer |
recordingID |
通話記録を取得
通話録音を取得します。 さらに、API コンシューマーは、通話に関与する特定の番号または従業員 (source、destination、または contact_id) に基づいて返されたレコードをフィルター処理できるだけでなく、方向に基づいて着信または発信呼び出しのみフィルターで除外したり、指定された日付範囲 (date_range) 内で行われた呼び出しのみをフィルターで除外したりできます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
録音 ID
|
record_id | integer |
録音の一意の ID。 |
|
制限
|
limit | integer |
取得する結果の数を制限します。 |
|
オフセット
|
offset | integer |
データを取得する結果を指定するために使用されます。 |
|
宛先番号
|
destination | string |
通話先の番号。 |
|
ソース電話番号
|
source | string |
発信元関係者の番号。 |
|
方向
|
direction | string |
通話が "着信" か "発信" かを示す "in" または "out"。 |
|
連絡先 ID
|
contact_id | integer |
通話に関与する従業員の一意 ID。 |
|
開始日
|
date_from | date-time |
フィルタリングされた日付範囲の開始日。 |
|
終了日
|
date_to | date-time |
フィルタリングされた日付範囲の終了日。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
version
|
version | string |
version |
status
|
status | string |
status |
statusCode
|
statusCode | integer |
statusCode |
message
|
message | string |
message |
data
|
data | array of object |
data |
recordingID
|
data.recordingID | integer |
recordingID |
callID
|
data.callID | integer |
callID |
caller
|
data.caller | string |
caller |
destination
|
data.destination | string |
destination |
direction
|
data.direction | string |
direction |
status
|
data.status | integer |
status |
callStarted
|
data.callStarted | string |
callStarted |
callConnected
|
data.callConnected | string |
callConnected |
callEnded
|
data.callEnded | string |
callEnded |
contactID
|
data.contactID | integer |
contactID |
recordingURL
|
data.recordingURL | string |
recordingURL |
音声プロンプトを取得
音声プロンプト エントリを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
音声プロンプト ID
|
prompt_id | integer |
オーディオ プロンプトの一意の ID。 |
|
制限
|
limit | integer |
取得する結果の数を制限します。 |
|
オフセット
|
offset | integer |
データを取得する結果を指定するために使用されます。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
version
|
version | string |
version |
status
|
status | string |
status |
statusCode
|
statusCode | integer |
statusCode |
message
|
message | string |
message |
data
|
data | array of object |
data |
id
|
data.id | integer |
id |
name
|
data.name | string |
name |
type
|
data.type | integer |
type |