クラス | |
| class | AgentPlace |
| Agent Placeクラスです。AgentSessionを継承しており、APIの高レベルな機能を提供します。詳細... | |
| class | AgentSession |
| エージェント・セッション・クラスです。サーバーへの接続、認証、および転送を管理します。AgentSessionオブジェクトは直接インスタンス化できませんので、代わりにAgentPlaceオブジェクトを作成してください。詳細... | |
| class | AgentStateReason |
| ACDの「受付不可」状態の理由について説明します。詳細... | |
| class | AudioNotification |
| 音声通知に関する情報です。詳細... | |
| class | Call |
| このクラスは、音声コールを表しています。詳細... | |
| class | CallParty |
| このクラスは、電話コールの1つのパーティー(当事者)について説明します。詳細... | |
| class | Contact |
| このクラスは、単一のCRMContactを表します。詳細... | |
| class | DirectoryCategory |
| このクラスは、ディレクトリカテゴリーを表します。詳細... | |
| class | DirectoryItem |
| このクラスは、単一のディレクトリ項目を表しています。詳細... | |
| class | Disposition |
| このクラスは、アイテムのdispositionを示します。詳細... | |
| class | Favorite |
| このクラスは、ユーザーのお気に入りリストにある1つの項目を表しています。詳細... | |
| class | Item |
| 「クラス」とは、ユーザーに割り当てられた1つの項目(インタラクション)を表します。これには、電話やチャットセッションなどが含まれます。詳細... | |
| class | ListRecordAddress |
| 架電リストのレコードアドレスデータを取得します。詳細... | |
| class | ListRecordData |
| 架電リストのレコードデータを取得します。詳細... | |
| class | PhoneCapabilities |
| このクラスは、ユーザーがログインしている電話の機能について説明しています。詳細... | |
| class | Recent |
| このクラスは、「履歴で最近使った項目」リスト内の個々の項目を表します。詳細... | |
| class | Service |
| このクラスは、Serviceオブジェクトを定義しています。詳細... | |
| class | Team |
| 「Class」は、ユーザーのチームを表します。詳細... | |
| class | User |
| このクラスは、単一のユーザーを表します。詳細... | |
| class | UserState |
| ユーザーの状態を説明します。詳細... | |
| class | Workitem |
| アウトバウンドワークアイテムのデータ。詳細... | |
| enum ADAPI.AgentState |
音声通知タイプの列挙。
| Enumerator | |
|---|---|
| Unknown | 不明. |
| CallWaitingInQueue | Call ユーザーのスキルセットに適合する案件が、キューに並んでいます。 |
| InternalChat | 内線チャットが届きました。 |
| ExternalChat | 外部チャットが届きました。 |
| SoftphoneRing | 新規音声コールの着信があります。 |
| SoftphoneCallWaiting | 別の通話中、新規着信がある場合(通話待受)。 |
| enum ADAPI.AuthType |
認証の種類。
| Enumerator | |
|---|---|
| Unknown | 型が不明です。まずAgentSession.checkAuthType()を呼び出してください。 |
| Legacy | 従来のServicePattern認証。 |
| SessionId | SessionID ベース認証(NewAuth)。 |
Call 接続が切断されると、列挙が行われます。
| Enumerator | |
|---|---|
| Normal | 通常の清算です。 |
| Busy | 宛先が話中状態です(SIP 486, 603)。 |
| DestinationUnknown | 宛先不明(SIP 404、604、またはダイヤルプラン)。 |
| DestinationNotRegistered | 宛先が登録されていません(SIP 404)。 |
| Redirect | SIP 301、302。 |
| Timeout | SIP トランザクションのタイムアウト。 |
| DestinationNotInService | この番号はサービス対象外(SIP 480)。 |
| Cancelled | 保留中のアウトバンドコールが、クライアントによりキャンセルされました。 |
| NoAnswer | 指定されたタイムアウト時間内に応答がありませんでした。 |
| Terminated | サーバーによって切断されたインバウンドまたはアウトバンドコールの応答。 |
| NetworkBusy | ネットワークが混雑しています(SIP 503)。 |
| InvalidNumber | 無効な番号です(SIP 404、原因 = 1)。 |
| Other | その他のすべての原因。 |
| Conferenced | Call SE によって、ピア・レグが会議に統合されたため、この接続は切断されました。 |
| enum ADAPI.CallState |
| enum ADAPI.ContactSource |
Contact ソース列挙。
| Enumerator | |
|---|---|
| Internal | 内部データベース。 |
| Salesforce | セールスフォース。 |
| Zendesk | Zendesk。 |
| RightNow | RightNow. |
| enum ADAPI.Direction |
Item (インタラクション)の方向の列挙。
| Enumerator | |
|---|---|
| Unknown | 方向不明です。 |
| Inbound | インバウンド項目がユーザーに配達されました。 |
| Outbound | ユーザーによって開始されたアウトバンド項目です。 |
Disposition システムタイプの列挙。これらのdispositionは、項目の自動処理に基づき、サーバーによって各項目に設定されます。
| Enumerator | |
|---|---|
| CallFailed | アウトバンドコールができません。 |
| RecordExpired | アウトバンドコール記録の期限が切れたため、再度の試行は行われません。 |
| Dropped | お客様によりコールの切断が行われました。 |
| Busy | お客様の電話は話中です。 |
| NoAnswer | お客様は、指定されたタイムアウト時間内にコールに応答されませんでした。 |
| FaxModem | Fas or modem tone was detected. |
| AnsweringMachine | Call 留守番電話に応答しました。 |
| Silence | Call 電話には応答しましたが、音声は聞こえませんでした。 |
| InvalidNumber | Call 電話網からその電話番号が無効であると報告されたため、ダイヤルできません。 |
| OtherConnectionIssue | その他の(特定されていない)電話コール障害。 |
| Abandoned | お客様が電話に応答しましたが、エージェントに転送される前に通話が切断されました。 |
| RemoteCongestion | 電話回線が混雑しているため、アウトバンドコールができません。 |
| NoAgent | システムは、その項目に対応するエージェントを見つけることができませんでした。 |
| NoDisposition | 具体的な disposition は設けられていません。 |
| Skipped | エージェントはその項目をスキップすることを選択しました。 |
| SystemFailure | その他システムエラー。 |
| AgentFailure | ??? |
| FinalizedByDialRule | この項目は、設定で指定されたダイヤル規則に基づいて確定されました。 |
| MaxAttemptsReached | そのアイテムの処理試行回数が上限を超過しました。 |
| DispositionNotFound | エージェントが提供したdispositionが、設定に見つかりませんでした。 |
| PhoneNetworkUnavailable | アウトバンドコールが発信できないのは、電話回線が利用できないためです。 |
| FastBusy | お客様の電話からは、速い話中音が聞こえました。 |
| Announcement | アウトバンドコールには、自動案内システムが応答しました。 |
| NetworkAnnouncement | アウトバンドコール時の電話回線のアナウンスが検出されました。 |
Disposition 「タイプ」の列挙。これらのdispositionは、エージェントごとに各項目に対して設定することができます。
| Enumerator | |
|---|---|
| Success | この項目は無事に完了しており、これ以上の処理は必要ありません。 |
| Failure | この項目は正常に完了しなかったため、これ以上の処理は必要ありません。 |
| Continue | 試行は完了しましたが、この項目についてはさらに処理中です。 |
| DoNotCall | お客様から、電話の発信を停止してほしいとのご要望がありました。 |
| Spam | この項目はスパムとして分類されています。 |
| enum ADAPI.ItemState |
Item 状態の列挙。
| enum ADAPI.LicenseStatus |
| enum ADAPI.MediaType |
モードコール側の相手は、着信に接続済みです。
| enum ADAPI.PartyRole |
Call またはチャットパーティの役割。
| enum ADAPI.PhoneType |
| enum ADAPI.PopupAction |
| enum ADAPI.PresenceState |
| enum ADAPI.Privilege |
User 権限の列挙。
| Enumerator | |
|---|---|
| Acd | キューからのインタラクションを受信できるようになります。 |
| CanViewAgents | スーパーバイザーは、その他ユーザーの状態を確認できるようになります。制限付きユーザーは、自分が監視中のチーム内のユーザーのみを表示できます。 |
| CanForceOtherAgentsState | スーパーバイザーが他のエージェントの状態を変更(「受付可能」への強制切り替えまたはログアウト)できるようになります。権限が制限されているユーザーは、自身が監督するチームに所属するユーザーの状態のみを強制的に変更できます。 |
| CanMonitorOrRecordCalls | スーパーバイザーが他のユーザーのコールをモニタリングできるようになります。制限対象のユーザーは、自身が監督するチームに所属するユーザーのコールをモニタリング・録音することができます。 |
| CanPullScreen | スーパーバイザーは、監視対象のユーザーのデスクトップに表示されている画面を取得することができます。権限が制限されているユーザーは、自分が管理しているチームに所属するユーザーの画面のみを取得できます。 |
| CanViewQueue | スーパーバイザーは、自身のチームが担当するキューのステータスを確認できます。アクセス権限が制限されているユーザーは、自身が監督するチームに関連付けられたサービスのキューの指標のみを表示できます。 |
| CanUseInternalChat | チャット経由で他のユーザーとコミュニケーションをとることができます。 |
| CanHandleCustomerChats | Webチャットでのやり取りを受け付けることができます。 |
| CanHandleEmails | メールによるやり取りを受け取ることができます。 |
| CanHandleLeads | 営業リードとのやり取りを受け取ることができます。 |
| CanHandleSMS | SMSを受信できるようになります。 |
| CanOperateCampaigns | アウトバンドキャンペーンの実施が可能になります。 |
| CanViewDirectory | ディレクトリ内のエントリを表示することができます。 |
| CanStartRecording | インタラクションの録画を開始することができます。 |
| CanStopRecording | インタラクションの録画を開始することができます。 |
| CanForcePopOutWindow | ???. |
| CanConfigRealtimeMetrics | リアルタイムのメトリクスを設定できるようになります。 |
| CanConfigAlerts | アラートの設定を行うことができます。 |
| CanTransfer | コールを転送することができます。 |
| CanMakeExternalCalls | 外部へのコールを発信できるようになります。 |
| CanSeeOtherAgentCases | その他のエージェントのケースを確認することができます。 |
| CanLogIntoAD | エージェントデスクトップにログインできるようになります。 |
| CanMaskEmailContent | メールのコンテンツを非表示にすることができます。 |
| CanUseRealtimeStatsAPI | API のリアルタイム統計情報を使用できるようになります。 |
| CanUseZendesk | Zendeskとの連携を使用できます。 |
| CanUseRightNow | RightNowとの連携を使用できます。 |
| CanUseFullAD | エージェントデスクトップの全機能を使用できます。 |
| CanListenCRMLinkedRecordings | CRMにリンクされた録音のリスニングを可能にします。 |
| CanViewAuditLogs | ユーザーが監査ログを表示できるようになります。 |
| CanConfigureCallCenter | ユーザーが「Call」の「センター設定」セクションで設定を編集できるようになります。 |
| CanConfigureDirectory | ユーザーがディレクトリを設定できるようになります。 |
| CanConfigureUsers | ユーザーは、ユーザーの作成・更新・削除を行うことができます。これには、役割の割り当ても含まれます。 ユーザーは、自身が保有する権限を持つ役割のみを割り当てることができます。ただし、スーパーバイザーは、自身が保有していない場合でも「Acd」役割を割り当てることができます。制限付きユーザーは、自身が監視するチーム内のユーザーのみを作成できます。(なお、これはダイヤルプラン内の「ソフトフォン」タイプのエントリを作成・更新・削除する間接的な権限も有することを意味します。) |
| CanUpdateUserSkills | ユーザーが他のユーザーのスキルを変更できるようになります。権限が制限されているユーザーは、自身が監視中のチームに所属するユーザーのスキルのみを変更できます。 |
| CanConfigureCallScenarios | ユーザーは、コールシナリオの作成・更新・削除を行うほか、その起動条件を変更することができます(ただし、これは「シナリオ」タイプのダイヤルプランエントリの作成・更新・削除機能を含むことを意味します)。 |
| CanListenToCallRecordings | ユーザーが通話録音を再生できるようになります。権限が制限されているユーザーは、自身が監視中のチームに所属するユーザーの通話録音のみを再生できます。 |
| CanConfigureRoles | ユーザーは、すでに割り当てられているものを含め、役割の作成・更新・削除を行うことができます。この権限を持つユーザーのみが、役割の追加・編集・削除を行うことができます。 |
| CanConfigurePhones | ユーザーは、ハードフォン、発信設定、およびアプリケーションの作成・更新・削除を行うことができます。さらに、外部番号を内線番号に割り当てることも可能です。 |
| CanSearchCalls | ユーザーがコール履歴を検索できるようになります。権限が制限されているユーザーは、自身が監視中のチームに所属するユーザーのコールのみを検索・表示できます。 |
| CanConfigureAllTeams | 制限付き権限から、管理対象のチーム、そのユーザー、および関連サービスに対する制限を消去します。チームの作成、チームへのユーザーの割り当て、およびチーム間のユーザーの移動が可能になります。 |
| CanGenerateAndViewReports | ユーザーがレポートを作成・表示できるようにします。権限が制限されているユーザーは、自身が監視中のユーザーやチーム、およびそれらに関連するサービスに関するレポートのみを作成・表示できます。 |
| CanGradeCalls | ユーザーは、モニタリング中や通話録音を聴取している際に、コールの評価を行うことができます。権限が制限されているユーザーは、自身が監視するチームに所属するユーザーのコールのみを評価することができます。 |
| CanConfigureReportDefinitions | ユーザーがレポート定義をアップロードしたり変更したりできるようになります。 |
| CanSetSystemWideSupervisorAlert | ユーザーが、リアルタイム表示パネルのしきい値設定をシステム全体に反映させることができます。 |
| CanSetSystemWideSupervisorRealtimeMetrics | ??? |
| CanPublishCannedChatResponses | ユーザーがシステム全体で標準的なチャット応答を公開したり、公開済みの応答を編集したりできるようになります。 |
| enum ADAPI.ResultCode |
結果コード。
| Enumerator | |
|---|---|
| Success | 成功。 |
| NotAllowed | このリクエストには、現在ログインしているユーザーには付与されていない権限が必要です。 |
| NogLogged | APIがログインしていません。 |
| InvalidArgs | 引数が無効です。 |
| LoggedWithoutPhone | 引数が無効です。 |
| Banned | ご要望の機能は、発信元で利用が制限されています。 |
| ForcedLogoutByOtherClient | 別のクライアントからセッションが強制的にログアウトされました。 |
| ForcedLogoutBySupervisor | スーパーバイザーに強制的にログアウトされました。 |
| InvalidRequest | 無効な(不明な)リクエストが送信されました。 |
| PhoneNotRegistered | エージェントの電話がサーバーに登録されていません。 |
| PhoneNotInDialPlan | ログイン時にご登録いただいた電話番号は、システムに存在しません。 |
| TenantDisabled | Userのテナントは、設定で無効になっています。 |
| DestinationUserNotLogged | メッセージの送信先であるユーザーは、システムにログインしていません。 |
| UserDisabledOrDeleted | User 設定で無効化されているか、削除されています。 |
| UserAlreadyLoggedIn | このユーザーはすでにログインしています。 |
| InvalidCredentials | ログイン情報が不正です。 |
| OtherUserLoggedWithPhone | 指定された電話番号でログインしているユーザーがすでにいます。 |
| InvalidToken | トークンが無効か、期限切れです。 |
| LoggedUsersLimitReached | テナントの制限を超過しているため、ユーザーをログインさせることができません。 |
| SipServerError | SIPサーバーの一般的なエラーです。 |
| UnknownError | 不明なエラーが発生しました。 |
Service メディアタイプの列挙。
| Enumerator | |
|---|---|
| VoiceInbound | インバウンド音声サービス。 |
| VoiceOutbound | アウトバンド音声サービス。 |
| VoiceBlended | (インバウンド・アウトバンドを組み合わせた)音声サービス。 |
| Chat | チャットサービス。 |
電子メールサービス。 | |
| Marketing | マーケティング(見込み客獲得)サービス。 |