CCPaaSフロントエンドSDK API V2.1.0

API SDKはメソッドのみを提供します。このドキュメントでは、発信API SDKの基本的な使用方法、注意事項、サンプルコードなどを提供します。

一、基本的な使用方法

SDKファイルを発信コンポーネントを埋め込む必要があるページに導入します。
CC PaaSシステムのサーバーサイドから、暗号化されたTokenを取得する方法を提供してもらいます。
サンプルコードをコピーし、設定パラメータ情報を修正して、対応するメソッドを呼び出してSDKを使用します。
API-SDKは単独で使用できます。UIインターフェースが必要な場合は、UI-SDKドキュメントをお読みください。

ダウンロードURL：

https://ccps.s4.udesk.cn/ccpaas-phone-sdk/sdk/cti-phone/2.2.0/call-center-class/index.js

二、注意事項

ブラウザ互換性

SDKは現在、IE9+（含む）のIEブラウザとそのカーネルに基づくブラウザ（360/qq/…）、その他の主要ブラウザ（chrome/firefox/…）をサポートしています。
可能であれば、最適なユーザー体験を得るためにIE10以降のバージョンへのアップグレードをお勧めします。
API-SDKの役割はメソッドを提供することであり、UI-SDKはインターフェースUIを提供します。既存のダイヤル、入力、ポップアップなどのインターフェース機能を使用する必要がある場合は、UI-SDKと併用する必要があります。

AppDataProvider Classの使用方法

UdeskCCPaasApiClass.AppDataProviderを通じてAppDataProvider Classクラスを取得します。
AppDataProviderを継承した新しいクラスを追加し、以下のメソッドをオーバーライドできます。
AppDataProvider内の各メソッドの戻り値は統一してPromiseである必要があります。そうでない場合、SDKコンポーネントの一部機能が異常になる可能性があります。

三、SDKの初期化と破棄

インスタンスの初期化

tokenは、CCPaaSバックエンドAPI#認証方法のSign値です。セキュリティ上の理由から、tokenはバックエンドで生成し、フロントエンドがAPIを通じて取得する必要があります。

  <!-- API-SDKのjsファイルを導入 -->
   <script src="https://ccps.s4.udesk.cn/ccpaas-phone-sdk/sdk/cti-phone/2.1.0/call-center-class.es6.js"></script>

let AppDataProviderBase = UdeskCCPaasApiClass.AppDataProvider;
class AppDataProvider extends AppDataProviderBase {
    GetToken() {
        return new Promise((resolve, reject) => {
            // リクエストを送信して認証情報を取得
            $.ajax({
                url: "https://xxxxxx/xxxxx" // 顧客が提供する対応するバックエンドインターフェース。フロントエンドにtokenを生成する役割。
            }).
                then(response => {
                    // respose.data={
                    // appId: "xxxxxxx" テナントの一意識別子
                    // timestamp: "xxxxxx" 認証用のタイムスタンプ
                    // token: "xxxxxxxxxx" 認証token
                    // };
                    resolve(response.data);
                });
        });
    },
}
// s4環境の例
let UdeskCCPaasApiClassInstance = new UdeskCCPaasApiClass({
    AgentId: "",
    AppId: "",
    AppDataProvider: new AppDataProvider(),
    Domain: "wss://tower-xcc1.s4.udesk.cn:443/ws",
    HttpDomain: "https://apigw-xcc1.s4.udesk.cn:443/backend",
    Log: function (message, type) {
        // reasonのタイプはobject
        // messageプロパティを含み、値はエラーメッセージ
        // 例:{message:"発信失敗"}
    }

});
UdeskCCPaasApiClassInstance.Init();

インスタンスの破棄

UdeskCCPaasApiClassInstance.Destroy();

四、UdeskCCPaasApiClass インスタンスパラメータ説明

名称	タイプ	説明	デフォルト値	必須
AppId	string	テナント識別子	""	はい
AgentId	string	オペレーター識別子	""	はい
LanguageCode	string	言語	"ZH-CN"	いいえ
AutoConnect	Bool	デフォルトで自動接続するか	true	いいえ
AppDataProvider	object	データプロバイダークラス	null	はい
Domain	string	websocket接続アドレス	""	はい
HttpDomain	string	インターフェースアドレス	" "	はい

メソッド

メソッド名	タイプ	説明
GetToken	function	認証情報の取得

用語説明

高度な通話機能	機能説明
三者通話後の転送	顧客とオペレーターAが通話中、オペレーターAが三者通話機能を使用して顧客とオペレーターA、オペレーターBの三者通話を実現した後、直接通話をオペレーターBに転送し、オペレーターAが切断、オペレーターBと顧客が通話します。
三者通話（外部回線）	顧客とオペレーターAが通話中、オペレーターAが三者通話機能を使用して外部回線オペレーターBを導入し、顧客とオペレーターA、外部回線オペレーターBが同時に通話します。
三者通話	顧客とオペレーターAが通話中、オペレーターAが三者通話機能を使用してオペレーターBを導入し、顧客とオペレーターA、Bが同時に通話します。
三者通話からの回収	顧客とオペレーターAが通話中、オペレーターAが三者通話機能を使用してオペレーターBを導入し、その後オペレーターBが切断、顧客とオペレーターAが通話を継続します。
相談	顧客とオペレーターAが通話中、オペレーターAが顧客との通話を一時停止し、顧客にオーディオを再生、オペレーターAがオペレーターBと通話し、相談終了後、オペレーターAが顧客との通話を再開します。
相談後の三者通話	顧客とオペレーターが通話中、オペレーターAがオペレーターBに相談した後、引き続き三者通話機能を使用して顧客とオペレーターA、オペレーターBの三者通話を実現できます。
相談後の転送	顧客とオペレーターが通話中、オペレーターAがオペレーターBに相談した後、通話をオペレーターBに転送し、オペレーターAが切断、オペレーターBと顧客が通話します。
外部回線への相談	顧客とオペレーターが通話中、オペレーターAが顧客との通話を一時停止し、顧客にオーディオを再生、オペレーターAが外部回線オペレーターBと通話し、相談終了後、オペレーターAが顧客との通話を再開します。
相談からの回収	顧客とオペレーターが通話中、オペレーターAがオペレーターBに相談した後、オペレーターBが切断、オペレーターAと顧客が通話を継続します。
密語	顧客とオペレーターが通話中、リーダーが密語機能を使用して、オペレーターと秘密通話を行うことができ、顧客には聞こえず、顧客とオペレーターの通話に影響しません。
強制介入	顧客とオペレーターが通話中、リーダーが強制介入機能を使用して、リーダー、オペレーター、顧客の三者通話を実現します。
通話遮断	顧客とオペレーターが通話中、リーダーが通話遮断機能を使用して、オペレーターを切断し、その後リーダーと顧客が通話します。
通話監視	顧客とオペレーターが通話中、リーダーが通話監視機能を使用して、オペレーターと顧客の通話を聞くことができますが、オペレーターと顧客はリーダーの声を聞くことができません。
転送	顧客とオペレーターが通話中、オペレーターAが通話をオペレーターBに転送し、オペレーターAが切断、オペレーターBと顧客が通話します。
外部回線への転送	顧客とオペレーターが通話中、オペレーターAが通話を外部回線オペレーターBに転送し、オペレーターAが切断、外部回線オペレーターBと顧客が通話します。
## 五、インターフェースAPI

戻り値パラメータ説明

名称	タイプ	説明
Message	string	メソッド実行の成功または失敗メッセージ
Code	string	対応するコード
Data	object/Array	返されるデータ
Visible	Bool	エラーメッセージをユーザーに直接表示できるかどうか

websocket接続

1.websocket接続を切断する

基本情報

メソッド名：Disconnect

概要

発信コンポーネントのwebsocket接続を切断する

例

呼び出し

UdeskCCPaasApiClassInstance.Disconnect()

リクエストパラメータ

なし

戻りデータ

なし

2.websocketに接続する

基本情報

メソッド名：ConnectAsync

概要

発信コンポーネントのwebsocketに接続する

例

呼び出し

UdeskCCPaasApiClassInstance.ConnectAsync().then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

戻りデータ

名称	タイプ	説明
promise	promise	成功、失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

発信関連

01.電話をかける

基本情報

メソッド名：MakeCallAsync

概要

発信コンポーネントの接続が成功した後、ユーザーが手動で電話発信メソッドを呼び出す

例

呼び出し

UdeskCCPaasApiClassInstance.MakeCallAsync("xxxxxxxxxxx").then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名称	タイプ	必須	説明
Number	string	true	発信する番号
Options	object	false	付帯データ、例：{ BizId: "" }
#### 返却データ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message, Code, Data, Visible）

02. 通話を切断する

基本情報

メソッド名： HangupAsync

概要

発信コンポーネントが通話終了後、ユーザーが手動で通話切断メソッドを呼び出します。

サンプル

呼び出し

UdeskCCPaasApiClassInstance.HangupAsync(CallId).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名称	タイプ	必須	説明
Options	String	true	通話ID（着信または通話中に取得したcallid）

返却データ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message, Code, Data, Visible）

03. 通話に応答する

基本情報

メソッド名： AnswerAsync

概要

発信コンポーネントが着信後、ユーザーが手動で通話応答メソッドを呼び出します。

サンプル

呼び出し

UdeskCCPaasApiClassInstance.AnswerAsync().then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

返却データ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message, Code, Data, Visible）

04. デバイスモードを設定する

基本情報

メソッド名： SetPhoneModeAsync

概要

発信コンポーネントが発信時、どのモード（IP電話、携帯電話、Web電話）で発信するかを選択できます。

サンプル

呼び出し

UdeskCCPaasApiClassInstance.SetPhoneModeAsync("voip").then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名称	タイプ	必須	説明
PhoneMode	string	true	エージェント通話モード（voip，cellphone，webrtc）

パラメータ説明

名称	説明
voip	IP電話
cellphone	携帯電話
webrtc	ウェブ電話

返却データ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

05. デバイスモードの取得

基本情報

メソッド名：GetPhoneModesAsync

概要

エージェントのすべての選択可能なデバイスを取得します

サンプル

呼び出し

UdeskCCPaasApiClassInstance.GetPhoneModesAsync().then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: [{
        Id: "cellphone",
        Name: "携帯電話"
    },
    {
        Id: "voip",
        Name: "IP電話"
    },
    {
        Id: "webrtc",
        Name: "ウェブ電話"
    }],
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

返却データ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

06. 全エージェント状態の取得

基本情報

メソッド名：GetAgentStatesAsync

概要

エージェントのすべての選択可能な状態を取得します

サンプル

呼び出し

UdeskCCPaasApiClassInstance.GetAgentStatesAsync().then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: [{
        Code: "idle", Label: "空き"
    },
    {
        Code: "busy", Label: "ビジー"
    },
    {
        Code: "onBreak", Label: "小休憩"
    },
    {
        Code: "offline", Label: "オフライン"
    },
    {
        Code: 101, Label: "昼食", Owner: "onBreak"
    },
    {
        Code: 102, Label: "手洗い", Owner: "onBreak"
    },
    {
        Code: 103, Label: "ハハ", Owner: "onBreak"
    },
    {
        Code: 107, Label: "残業", Owner: "onBreak"
    }],
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

レスポンスデータ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message、Code、Data、Visible）

07. エージェントステータスを設定

基本情報

メソッド名：SetAgentStateAsync

概要

エージェントの全ステータスを取得

サンプル

呼び出し

ビジー、休憩、アイドル、オフラインに切り替え

UdeskCCPaasApiClassInstance.SetAgentStateAsync("busy").then(resp=>{})

カスタム休憩に切り替え

UdeskCCPaasApiClassInstance.SetAgentStateAsync("onBreak", 101).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名称	値	必須	説明
State	string	true	エージェントステータス("idle","busy","onBreak","offline")
SubState	string	false	カスタムステータス値(切り替えるステータスがカスタム休憩の場合、対応するcodeを渡す必要があります)

レスポンスデータ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message、Code、Data、Visible）

08. Web電話基本情報を取得

基本情報

メソッド名：GetWebPhoneInfoAsync

概要

Web電話の基本情報を取得

サンプル

呼び出し

UdeskCCPaasApiClassInstance.GetWebPhoneInfoAsync().then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: {
        SipServer: "xxxxx",
        Number: "xxxxx",
        Password: "xxxxx",
    },
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

レスポンスデータ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message、Code、Data、Visible）
#### 返却データ説明

名称	タイプ	説明
SipServer	string	SIPサーバーアドレス
Number	string	アカウント
Password	string	パスワード

09. 着信の整理時間を取得

基本情報

メソッド名：GetCallInWrapUpTimeAsync

概要

着信の整理時間を取得します

サンプル

呼び出し

UdeskCCPaasApiClassInstance.GetCallInWrapUpTimeAsync().then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: {
        WrapUpTime: 0
    },
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

返却データ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

返却データ説明

名称	タイプ	説明
WrapUpTime	number	整理時間

10. 中継番号リストを取得

基本情報

メソッド名：GetSpNumbersAsync

概要

選択可能な中継番号リストを取得します

サンプル

呼び出し

UdeskCCPaasApiClassInstance.GetSpNumbersAsync({OwnerType: "app"}).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: ["xxxxx", "xxxxx", "xxxxx"]
    Message: "",
    Visible: false
}

リクエストパラメータ

名称	タイプ	必須	説明
Options	object	true	{ OwnerType: "app" }

リクエストパラメータ説明

名称	タイプ	説明
OwnerType	string	テナント: app エージェント：agent

返却データ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

11. 現在のデフォルト中継番号を取得

基本情報

メソッド名：GetCurrentSpNumberAsync

概要

現在のオペレーター/テナントのデフォルト中継番号を取得します。

例

呼び出し

UdeskCCPaasApiClassInstance.GetCurrentSpNumberAsync({OwnerType: "app"}).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: "xxxxx",
    Message: "",
    Visible: false
}

リクエストパラメータ

名前	タイプ	必須	説明
Options	object	true	{ OwnerType: "app" }

リクエストパラメータ説明

名前	タイプ	説明
OwnerType	string	テナント: app オペレーター：agent

返却データ

名前	タイプ	説明
promise	promise	成功、失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

12.デフォルト中継番号を設定

基本情報

メソッド名：SetSpNumberAsync

概要

オペレーター/テナントのデフォルト中継番号を設定します。

例

呼び出し

UdeskCCPaasApiClassInstance.SetSpNumberAsync({OwnerType: "app", DisplayNumber: "xxxxxxxx"}).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名前	タイプ	必須	説明
Options	object	true	{ OwnerType: "app", DisplayNumber: "xxxxxxxx" }

リクエストパラメータ説明

名前	タイプ	説明
OwnerType	string	テナント: app オペレーター：agent
DisplayNumber	string	設定する中継番号

返却データ

名前	タイプ	説明
promise	promise	成功、失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

13.端末(IP電話機, ウェブ電話)の情報を取得

基本情報

メソッド名：GetAgentTerminalInfoAsync

概要

端末（IP電話、Web電話）の情報を取得します

例

呼び出し

UdeskCCPaasApiClassInstance.GetAgentTerminalInfoAsync({TerminalType: "voip"}).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: {
        SipServer: "xxxxx",
        Number: "xxxxx",
        Password: "xxxxx",
    },
    Message: "",
    Visible: false
}

リクエストパラメータ

名前	タイプ	必須	説明
Options	object	true	{TerminalType: "voip"}

リクエストパラメータ説明

名前	タイプ	説明
TerminalType	string	IP電話: voip Web電話：webrtc

戻りデータ

名前	タイプ	説明
promise	promise	成功、失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

14.三者通話からの回収

基本情報

メソッド名：RetrieveAfterThreeWayAsync

概要

三者通話中に、手動で回収メソッドを呼び出します

例

呼び出し

UdeskCCPaasApiClassInstance.RetrieveAfterThreeWayAsync({ CallId:　"xxxxxxxxx" }).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名前	タイプ	必須	説明
Options	object	true	通話ID,{ CallId:　"xxxxxxxxx" }

戻りデータ

名前	タイプ	説明
promise	promise	成功、失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

15.コンサルテーションからの回収

基本情報

メソッド名：EndConsultationAsync

概要

コンサルテーション通話中に、手動で回収メソッドを呼び出します

サンプル

呼び出し

UdeskCCPaasApiClassInstance.EndConsultationAsync({ CallId:　"xxxxxxxxx" }).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名前	タイプ	必須	説明
Options	object	true	通話ID,{ CallId:　"xxxxxxxxx" }

返却データ

名前	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

16. 復帰

基本情報

メソッド名：RecoveryAsync

概要

通話保持中に、手動で復帰メソッドを呼び出します。

サンプル

呼び出し

UdeskCCPaasApiClassInstance.RecoveryAsync({ CallId:　"xxxxxxxxx" }).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名前	タイプ	必須	説明
Options	object	true	通話ID,{ CallId:　"xxxxxxxxx" }

返却データ

名前	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

17. コンサルテーションから三者通話へ

基本情報

メソッド名：ConsultationToThreeWayAsync

概要

コンサルテーション中に、手動で三者通話メソッドを呼び出します。

サンプル

呼び出し

UdeskCCPaasApiClassInstance.ConsultationToThreeWayAsync({ CallId:　"xxxxxxxxx" }).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名前	タイプ	必須	説明
Options	object	true	通話ID,{ CallId:　"xxxxxxxxx" }
#### 返却データ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message、Code、Data、Visible）

18. 三者通話後の転送

基本情報

メソッド名： TransferAfterThreeWayAsync

概要

三者通話中に、手動で転送を呼び出すメソッドです。

例

呼び出し

UdeskCCPaasApiClassInstance.TransferAfterThreeWayAsync({ CallId:　"xxxxxxxxx" }).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名称	タイプ	必須	説明
Options	object	true	通話ID, { CallId:　"xxxxxxxxx" }

返却データ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message、Code、Data、Visible）

19. ウィスパー（密語）

基本情報

メソッド名： WhisperAsync

概要

通話中に、手動でウィスパー（密語）を呼び出すメソッドです。

例

呼び出し

UdeskCCPaasApiClassInstance.WhisperAsync({ CallId:　"xxxxxxxxx", AgentId: "xxxxxxxxx" }).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名称	タイプ	必須	説明
Options	object	true	通話ID, { CallId:　"xxxxxxxxx" }

リクエストパラメータ説明：

名称	値	必須	説明
CallId	string	true	通話ID
AgentId	string	true	ウィスパー対象のエージェントID

返却データ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message、Code、Data、Visible）
### 20.強制割り込み

基本情報

メソッド名：ForcePickupAsync

概要

通話中に、手動で強制割り込みを呼び出す方法

例

呼び出し

UdeskCCPaasApiClassInstance.ForcePickupAsync({ CallId:　"xxxxxxxxx", AgentId: "xxxxxxxxx", AgentPhone: "xxxxxx" }).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名前	タイプ	必須	説明
Options	object	true	通話ID,{ CallId:　"xxxxxxxxx" }

リクエストパラメータ説明：

名前	値	必須	説明
CallId	string	true	通話ID
AgentId	string	true	密話されるエージェントのID
AgentPhone	string	true	匿名エージェントの電話番号

返却データ

名前	タイプ	説明
promise	promise	成功、失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

21.IVR転送

基本情報

メソッド名：TransferIvrAsync

概要

通話中に、手動でIVR転送を呼び出す方法

例

呼び出し

UdeskCCPaasApiClassInstance.TransferIvrAsync({ CallId:　"xxxxxxxxx", IvrId: "", NodeId: "", JumpType: "" }).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名前	タイプ	必須	説明
Options	object	true	{ CallId:　"xxxxxxxxx", IvrId: "xx", NodeId: "xx", JumpType: " agent_hangup"} }

リクエストパラメータ説明：

名前	値	必須	説明
CallId	string	true	通話ID
IvrId	string	true	IVRのID
NodeId	string	true	ノードID
JumpType	string	true	転送モード
#### 返却データ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message, Code, Data, Visible）

22. IVRノードリストの取得

基本情報

メソッド名： GetIvrNodesAsync

概要

IVRノードリストを取得するメソッドです。

サンプル

呼び出し

UdeskCCPaasApiClassInstance.GetIvrNodesAsync("25").then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: [
        {
            id: 1,
            name: "ivrテスト"
        },
    ],
    Message: "",
    Visible: false
}

リクエストパラメータ

名称	タイプ	必須	説明
id	string	true	IVRのノードID

返却データ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message, Code, Data, Visible）

23. キューリストの取得

基本情報

メソッド名： GetQueuesAgentsAsync

概要

キューリストを取得するメソッドです。

サンプル

呼び出し

UdeskCCPaasApiClassInstance.GetQueuesAgentsAsync().then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: [{
        Name: "鄭玲キュー",
        QueueId: "2",
        Strategy: 2,
        Timeout: 60,
    }],
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

リクエストパラメータ説明

名称	タイプ	必須	説明
CallId	string	true	通話ID
IvrId	string	true	IVRのID
NodeId	string	true	ノードID
JumpType	string	true	転送モード

返却データ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message, Code, Data, Visible）
#### 返却データ説明

名称	値	説明
Name	string	キュー名
QueueId	string	キューID

24.オペレータ転送/外部転送

基本情報

メソッド名：TransferAsync

概要

通話中に、手動で転送を呼び出すメソッド

例

呼び出し

UdeskCCPaasApiClassInstance.TransferAsync({ CallId:　"xxxxxxxxx", AgentId: "xxxxxxxxx" }).then(resp=>{})

UdeskCCPaasApiClassInstance.TransferAsync({ CallId:　"xxxxxxxxx", AgentPhone: "xxxxxxxxx" }).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名称	タイプ	必須	説明
Options	object	true	{ CallId:　"xxxxxxxxx", AgentId: "xxxxxxxxx" }

リクエストパラメータ説明：

名称	値	必須	説明
CallId	string	true	通話ID
AgentId	string	true	転送先オペレータID
AgentPhone	string	true	外部転送先の電話番号

返却データ

名称	タイプ	説明
promise	promise	成功、失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

25.保留

基本情報

メソッド名：HoldAsync

概要

通話中に、手動で通話を保留するメソッド

例

呼び出し

UdeskCCPaasApiClassInstance.HoldAsync({ CallId:　"xxxxxxxxx" }).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名称	タイプ	必須	説明
Options	object	true	{ CallId:　"xxxxxxxxx" }
#### リクエストパラメータ説明

名称	値	必須	説明
CallId	string	true	通話ID

返却データ

名称	型	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message, Code, Data, Visible）

26. コンサルテーション

基本情報

メソッド名： ConsultationAsync

概要

通話中に、手動でコンサルテーション通話を呼び出すメソッドです。

サンプル

呼び出し

UdeskCCPaasApiClassInstance.ConsultationAsync({ CallId: "xxxxxxxxx", AgentId: "xxx" }).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名称	型	必須	説明
Options	object	true	{ CallId: "xxxxxxxxx", AgentId: "xxx" }

リクエストパラメータ説明

名称	値	必須	説明
CallId	string	true	通話ID
AgentId	string	true	コンサルテーション対象エージェントID

返却データ

名称	型	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message, Code, Data, Visible）

27. 三者通話

基本情報

メソッド名： ThreewayAsync

概要

通話中に、手動で三者通話を呼び出すメソッドです。

サンプル

呼び出し

UdeskCCPaasApiClassInstance.ThreewayAsync({ CallId: "xxxxxxxxx", AgentId: "xxx" }).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名称	型	必須	説明
Options	object	true	{ CallId: "xxxxxxxxx", AgentId: "xxx" }
#### リクエストパラメータ説明：

名称	値	必須	説明
CallId	string	true	通話ID
AgentId	string	true	第三者宛先オペレータID

返却データ

名称	型	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message, Code, Data, Visible）

28. 相談後の転送

基本情報

メソッド名： ConsultationToTransferAsync

概要

相談中に、手動で転送を呼び出すメソッドです。

例

呼び出し

UdeskCCPaasApiClassInstance.ConsultationToTransferAsync({ CallId: "xxxxxxxxx", AgentId: "xxx" }).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名称	型	必須	説明
Options	object	true	{ CallId: "xxxxxxxxx", AgentId: "xxx" }

リクエストパラメータ説明：

名称	値	必須	説明
CallId	string	true	通話ID
AgentId	string	true	転送先オペレータID

返却データ

名称	型	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message, Code, Data, Visible）

29. キューへの転送

基本情報

メソッド名： TransferQueueAsync

概要

通話中に、手動でキューへの転送を呼び出すメソッドです。

例

呼び出し

UdeskCCPaasApiClassInstance.TransferQueueAsync({ CallId: "xxxxxxxxx", QueueId: "xxx" }).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名称	タイプ	必須	説明
Options	object	true	{ CallId:　"xxxxxxxxx", QueueId: "xxx" }

リクエストパラメータ説明：

名称	値	必須	説明
CallId	string	true	通話ID
QueueId	string	true	転送先キューのID

レスポンスデータ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message, Code, Data, Visible）

30. 割り込み

基本情報

メソッド名：SubstituteAsync

概要

通話を手動で割り込むメソッドを呼び出します

サンプル

呼び出し

UdeskCCPaasApiClassInstance.SubstituteAsync({ CallId:　"xxxxxxxxx", AgentId: "xxx" }).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名称	タイプ	必須	説明
Options	object	true	{ CallId:　"xxxxxxxxx", AgentId: "xxx" }

リクエストパラメータ説明：

名称	値	必須	説明
CallId	string	true	通話ID
AgentId	string	true	割り込み対象のオペレータID

レスポンスデータ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message, Code, Data, Visible）

31. モニタリング

基本情報

メソッド名：EavesdropAsync

概要

通話を手動でモニタリングするメソッドを呼び出します

サンプル

呼び出し

UdeskCCPaasApiClassInstance.EavesdropAsync({ CallId:　"xxxxxxxxx", AgentId: "xxx" }).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: null,
    Message: "",
    Visible: false
}

リクエストパラメータ

名称	タイプ	必須	説明
Options	object	true	{ CallId:　"xxxxxxxxx", AgentId: "xxx" }

リクエストパラメータ説明：

名称	値	必須	説明
CallId	string	true	通話ID
AgentId	string	true	監視対象エージェントID

返却データ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

32.他のエージェントリストの取得

基本情報

メソッド名：GetOtherAgentsAsync

概要

他のエージェントリストを取得するメソッド

例

呼び出し

UdeskCCPaasApiClassInstance.GetOtherAgentsAsync({ State:　"idle" }).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: [{
        AgentId: "78",
        AppId: "xxxxxx",
        Email: "diandian@test.cn",
        Enable: true,
        ExtState: 0,
        ExtenInfos: null,
        Extensions: null,
        Mobile: "xxxxxxx",
        Name: "xxxxxxx",
        Queues: null,
        QueuesNames: null,
        Role: "agent",
        State: 1,
        WorkId: "",
        WrapUpTime: 0,
    }],
    Message: "",
    Visible: false
}

リクエストパラメータ

名称	タイプ	必須	説明
Options	object	true	{ State:　"idle" }

リクエストパラメータ説明：

名称	値	必須	説明
State	string	false	エージェント状態空き状態:idle
#### 返却データ

名称	型	説明
promise	promise	成功・失敗コールバック（失敗コールバック引数：Message、Code、Data、Visible）

返却データ説明

名称	値	説明
AgentId	string	エージェントID
AppId	string	アプリID
Enable	string	利用可否

33. 番号プール/中継番号リストの取得

基本情報

メソッド名： GetNumberPoolAndSpNumAsync

概要

番号プール/中継番号リストを取得するメソッドです。

例

呼び出し

UdeskCCPaasApiClassInstance.GetNumberPoolAndSpNumAsync({type}).then(resp => {})

レスポンス

{
    Code: "0000",
    Data: {
        list: [],
        defaultId: "xxxxxx",
    },
    Message: "",
    Visible: false
}

リクエストパラメータ

名称	型	必須	説明
type	string	true	{ type：1 中継番号取得、type：2 番号プール取得 }

返却データ

名称	型	説明
promise	promise	成功・失敗コールバック（失敗コールバック引数：Message、Code、Data、Visible）

返却データ説明

名称	値	説明
番号プールまたは中継番号リスト	array	resp.Data.list
選択されたリスト内のID	string	resp.Data.defaultId

typeに応じて対応するリストを返却します。現在のリストに選択項目がある場合、defaultIdは対応する選択項目のIDとなり、それ以外の場合はnullとなります。中継番号と番号プールを切り替えるたびに、新しいリストが再取得されます。

34. 番号プール/中継番号リストの選択

基本情報

メソッド名： SetSpNumberPoolNumAsync

概要

対応する番号プールまたは中継番号を選択します。

例

呼び出し

 UdeskCCPaasApiClassInstance.SetSpNumberPoolNumAsync({ type, id}).then(resp => {})

レスポンス

{
    Code: "0000",
    Data: {

    },
    Message: "",
    Visible: false
}

リクエストパラメータ

名前	タイプ	必須	説明
type	string	true	{ type：1 選択されたのが中継番号であることを示す、type：2 選択されたのが番号プールであることを示す}
id	string	true	選択された対応する番号プールまたは中継番号のid

返却データ

名前	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

返却データ説明

名前	値	説明

中継番号と番号プールを切り替えるたびに新しいリストが再取得され、選択すると即時有効になります。

35.ミュート/ミュート解除

基本情報

メソッド名：MuteAsync/UnmuteAsync

概要

注：ウェブ電話モードでのみこの機能が利用可能です。

例

呼び出し

 UdeskCCPaasApiClassInstance.MuteAsync({ CallId: 'xxxxxx' }).then(resp=>{})

 UdeskCCPaasApiClassInstance.UnmuteAsync({ CallId: 'xxxxxx' }).then(resp=>{})

レスポンス

{
    Code: "0000",
    Data: {

    },
    Message: "",
    Visible: false
}

リクエストパラメータ

名前	タイプ	必須	説明
callId	string	true

返却データ

名前	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

返却データ説明

名前	値	説明
#### *コンポーネントクラス*

1.Init クラスインスタンスの初期化

2.Destory クラスインスタンスの破棄

六、イベント

通話イベントの監視

udeskCtiPhoneSdkInstance.on("event.udesk-cc-paas", (conversation) => {

});

通話イベント監視の解除

udeskCtiPhoneSdkInstance.off("event.udesk-cc-paas");

1. エージェントステータスが変更されたときにトリガー

基本情報

メソッド名：AgentStateChanged

概要

エージェントステータスが変更されたときにトリガーされる監視イベント

例

呼び出し

UdeskCCPaasApiClassInstance.on("AgentStateChanged",function(resp){})

レスポンス

{
    Code: "0000",
    Data: [{
        CurState: "busy",
        CurStateSubId: "0",
        OldState: "idle"
    }],
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

返却データ

名前	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

返却データ説明

名前	タイプ	説明
CurState	string	現在のエージェントステータス
CurStateSubId	string	現在のエージェントのsubId
OldState	string	以前のステータス

2. 電話モード変更

基本情報

メソッド名：PhoneModeChanged

概要

電話モードが変更されたときの監視イベント

例

呼び出し

UdeskCCPaasApiClassInstance.on("PhoneModeChanged",function(resp){})

レスポンス

{
    Code: "0000",
    Data: [{
        CurContact: "voip"
        CurExtState: "offline"
        CurNumber: "90310468561028"
    }],
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

返却データ

名前	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）
#### 返却データ説明

名称	値	説明
CurContact	string	現在のデバイスモード
CurExtState	string	現在のデバイスの状態
CurNumber	string	現在のデバイスの番号

3. 電話機状態変更

基本情報

メソッド名：PhoneStateChanged

概要

電話機状態変更の監視イベント

例

呼び出し

UdeskCCPaasApiClassInstance.on("PhoneStateChanged",function(resp){})

レスポンス

{
    Code: "0000",
    Data: [{
        CallID: "",
        CurState: "busy"
    }],
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

返却データ

名称	型	説明
promise	promise	成功、失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

返却データ説明

名称	値	説明
CallID	string	通話ID
CurState	string	現在のカスタマーサポート状態

4. 通話コンポーネント準備完了

基本情報

メソッド名：Ready

概要

通話コンポーネント準備完了の監視イベント

例

呼び出し

UdeskCCPaasApiClassInstance.on("Ready",function(resp){})

レスポンス

{
    Code: "0000",
    Data: [{
        CurExtState:"offline"
        CurMode:"voip"
        CurState:"busy"
    }],
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

返却データ

名称	型	説明
promise	promise	成功、失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）
#### 返却データ説明

名称	値	説明
CurExtState	string	現在のデバイス状態
CurMode	string	現在の電話機モード
CurState	string	現在のカスタマーサポート状態

5. 高度な通話呼状態変更

基本情報

メソッド名：AdvancedCallStatusChanged

概要

高度な通話呼状態変更の監視イベント

例

呼び出し

UdeskCCPaasApiClassInstance.on("AdvancedCallStatusChanged",function(resp){})

レスポンス

{
    Code: "0000",
    Data: {
        AdvancedCallStatus: "Originated",
        AgentInfo: {TelNumber: "90310468561028"},
        CallAuthority: {
            OnBarButtonSwitch: true,
            AllowTransferAfterThreeWay: true,
            AllowHold: false,
            AllowConsultation: false,
            AllowThreeWayAfterConsultation: fasle,
            AllowTransferAfterConsultation: fasle,
            AllowHangup: false,
            AllowAnswer: false,
            AllowTransfer: false,
            AllowEndConsultation: false,
            AllowCancel: false,
            AllowUnHold: false,
            AllowThreeWay: false,
            AdvancedCallStatus: false,
        },
        CallDirection: "Outbound",
        CallEvent: "Originated",
        CallID: "ea648a5d-56f6-432b-44e1-0941febbb870",
        CallType: "OtherIn",
        CalledInfo: {TelNumber: "15712886965", City: "北京"}, //被呼情報
        CallerInfo: {TelNumber: "90310468561028"},  //発呼情報
        ChannelUUID: "42de0839-74ba-442d-a3a5-7744029bd573",
        CustomerInfo: {TelNumber: "15712886965", City: "北京"}, //顧客情報
        DisplayInfo: {TelNumber: "051480114036", City: "揚州市"}, //表示情報
        WorkFlow: "out_callback",
    },
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

レスポンスデータ

名前	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message、Code、Data、Visible）

レスポンスデータの説明

名前	値	説明
OnBarButtonSwitch	bool	取回ボタンの表示/非表示
AllowTransferAfterThreeWay	bool	三者通話後の転送ボタンの表示/非表示
AllowHold	bool	保留ボタンの表示/非表示
AllowConsultation	bool	相談ボタンの表示/非表示
AllowThreeWayAfterConsultation	bool	相談後の三者通話ボタンの表示/非表示
AllowTransferAfterConsultation	bool	相談後の転送ボタンの表示/非表示
AllowHangup	bool	通話終了ボタンの表示/非表示
AllowAnswer	bool	応答ボタンの表示/非表示
AllowTransfer	bool	転送ボタンの表示/非表示
AllowEndConsultation	bool	相談取回ボタンの表示/非表示
AllowCancel	bool	三者通話取回ボタンの表示/非表示
AllowUnHold	bool	復帰ボタンの表示/非表示
AllowThreeWay	bool	三者通話ボタンの表示/非表示
AdvancedCallStatus	bool	現在の状態

6.サーバー状態の同期

基本情報

メソッド名：GetState

概要

サーバー状態の同期を監視するイベント

サンプルコード

呼び出し

UdeskCCPaasApiClassInstance.on("GetState",function(resp){})

レスポンス

{
    Code: "0000",
    Data: {
        AdvancedCallStatus: undefined,
        AgentInfo: undefined,
        CallDirection: "",
        CallID: "",
        CallType: undefined,
        CurContact: "90310468561028",
        CurExtState: "idle",
        CurMode: "voip",
        CurState: "idle",
        CurSubStateId: "",
        CustomerInfo: undefined,
        DestNumber: "",
        DestNumberLoc: "",
        Payload: null,
        SpNumber: "",
        StartTime: "",
        UserData: "",
    },
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

レスポンスデータ

| 名称 | タイプ | 説明 | | ------- | ------ | ----- | --------------------------- | | promise | promise | 成功・失敗コールバック（失敗コールバックパラメータ：Message、Code、Data、Visible） |

レスポンスデータ説明

| 名称 | タイプ | 説明 | | ---------------- | ------ | ----- | ------------- | | CallDirection | string | 通話方向（現在通話中の場合） | | CallID | string | 通話ID （現在通話中の場合） | | CurExtState | string | 現在の電話機状態 | | CurMode | string | 現在の電話機モード | | CurState | string | 現在のオペレーター状態 | | CurSubStateId | string | 現在のオペレーター休憩サブ状態 | | DestNumber | string | 通話先番号（現在通話中の場合） | | StartTime | string | 現在の勤務状態開始時間（現在通話中の場合） |

7.着信呼び出し

基本情報

メソッド名：Delivered

概要

着信呼び出しの監視イベント

サンプルコード

呼び出し

UdeskCCPaasApiClassInstance.on("Delivered",function(resp){})

レスポンス

{
    Code: "0000",
    Data: {
        CallID: "",
        AgentInfo: {},
        CustomerInfo: {},
        FromQueue: "",
        DisplayNum: undefined,
        WorkFlow: "",
        CallAuthority: "",
        CallType: "",
    },
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

レスポンスデータ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message、Code、Data、Visible）

レスポンスデータ説明

名称	タイプ	説明
CallID	string	通話ID
AgentInfo	object	オペレーター情報,{City}
CustomerInfo	object	顧客情報,,{City,Number}
FromQueue	string	通話元
DisplayNum	string	発信者番号表示
WorkFlow	string	通話方向( out_direct，in，out_callback)
CallAuthority	object	通話権限
CallType	string	通話タイプ(着信、発信、三者通話、コンサルテーション等)
### 8.発信呼び出し

基本情報

メソッド名：Originated

概要

発信呼び出し（呼び出し音鳴動）の監視イベント

例

呼び出し

UdeskCCPaasApiClassInstance.on("Originated",function(resp){})

レスポンス

{
    Code: "0000",
    Data: {
        CallID: "",
        AgentInfo: {},
        CustomerInfo: {},
        FromQueue: "",
        DisplayNum: undefined,
        WorkFlow: "",
        CallAuthority: "",
        CallType: "",
    },
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

返却データ

名前	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

返却データ説明

名前	タイプ	説明
CallID	string	callId
AgentInfo	object	エージェント情報,{City}
CustomerInfo	object	顧客情報,,{City,Number}
FromQueue	string	コールソース
DisplayNum	string	発信者番号表示
WorkFlow	string	コール方向( out_direct，in，out_callback)
CallAuthority	object	コール権限
CallType	string	コールタイプ(着信,発信,三者通話,コンサルティング等)

9.通話中

基本情報

メソッド名：Established

概要

通話中の監視イベント

例

呼び出し

UdeskCCPaasApiClassInstance.on("Established",function(resp){})

応答

{
    Code: "0000",
    Data: {
        CallID: "",
        AgentInfo: {},
        CustomerInfo: {},
        FromQueue: "",
        DisplayNum: undefined,
        WorkFlow: "",
        CallAuthority: "",
        CallType: "",
    },
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

返却データ

名前	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message、Code、Data、Visible）

返却データ説明

名前	タイプ	説明
CallID	string	callId
AgentInfo	object	エージェント情報,{City}
CustomerInfo	object	顧客情報,,{City,Number}
FromQueue	string	コールソース
DisplayNum	string	発信者番号表示
WorkFlow	string	コール方向( out_direct、in、out_callback)
CallAuthority	object	コール権限
CallType	string	コールタイプ(着信、発信、三者通話、コンサルティングなど)

10.通話終了

基本情報

メソッド名：ConnectionCleared

概要

通話終了のリスナーイベント

例

呼び出し

UdeskCCPaasApiClassInstance.on("ConnectionCleared",function(resp){})

応答

{
    Code: "0000",
    Data: {
        CallID: "",
        AgentInfo: {},
        CustomerInfo: {},
        FromQueue: "",
        DisplayNum: undefined,
        WorkFlow: "",
        CallAuthority: "",
        CallType: "",
    },
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

レスポンスデータ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message、Code、Data、Visible）

レスポンスデータ説明

名称	タイプ	説明
CallID	string	callId
AgentInfo	object	エージェント情報,{City}
CustomerInfo	object	顧客情報,{City,Number}
FromQueue	string	コールソース
DisplayNum	string	発信者番号表示
WorkFlow	string	コール方向( out_direct、in、out_callback)
CallAuthority	object	通話権限
CallType	string	通話タイプ(着信、発信、三者通話、コンサルティングなど)

11.通話保留

基本情報

メソッド名：Held

概要

通話保留のリスナーイベント

サンプルコード

呼び出し

UdeskCCPaasApiClassInstance.on("Held",function(resp){})

レスポンス

{
    Code: "0000",
    Data: {
        CallID: "",
        AgentInfo: {},
        CustomerInfo: {},
        FromQueue: "",
        DisplayNum: undefined,
        WorkFlow: "",
        CallAuthority: "",
        CallType: "",
    },
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

レスポンスデータ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message、Code、Data、Visible）
#### 返却データ説明

名称	タイプ	説明
CallID	string	callId
AgentInfo	object	エージェント情報,{City}
CustomerInfo	object	顧客情報,,{City,Number}
FromQueue	string	コールソース
DisplayNum	string	発信者番号表示
WorkFlow	string	コール方向( out_direct，in，out_callback)
CallAuthority	object	コール権限
CallType	string	コールタイプ(着信,発信,三者通話,コンサルティング等)

12.保留中のコールを再開する

基本情報

メソッド名：Retrieved

概要

保留中のコールを再開するためのリスナーイベント

サンプルコード

呼び出し

UdeskCCPaasApiClassInstance.on("Retrieved",function(resp){})

レスポンス

{
    Code: "0000",
    Data: {
        CallID: "",
        AgentInfo: {},
        CustomerInfo: {},
        FromQueue: "",
        DisplayNum: undefined,
        WorkFlow: "",
        CallAuthority: "",
        CallType: "",
    },
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

返却データ

名称	タイプ	説明
promise	promise	成功、失敗コールバック（失敗コールバックパラメータ：Message，Code，Data，Visible）

返却データ説明

名称	タイプ	説明
CallID	string	callId
AgentInfo	object	エージェント情報,{City}
CustomerInfo	object	顧客情報,,{City,Number}
FromQueue	string	コールソース
DisplayNum	string	発信者番号表示
WorkFlow	string	コール方向( out_direct，in，out_callback)
CallAuthority	object	コール権限
CallType	string	コールタイプ(着信,発信,三者通話,コンサルティング等)
### 13. 三方通話

基本情報

メソッド名：Conferenced

概要

三方通話の監視イベント

例

呼び出し

UdeskCCPaasApiClassInstance.on("Conferenced",function(resp){})

応答

{
    Code: "0000",
    Data: {
        CallID: "",
        AgentInfo: {},
        CustomerInfo: {},
        FromQueue: "",
        DisplayNum: undefined,
        WorkFlow: "",
        CallAuthority: "",
        CallType: "",
    },
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

返却データ

名前	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message、Code、Data、Visible）

返却データ説明

名前	タイプ	説明
CallID	string	callId
AgentInfo	object	エージェント情報,{City}
CustomerInfo	object	顧客情報,,{City,Number}
FromQueue	string	通話元
DisplayNum	string	発信者番号表示
WorkFlow	string	通話方向( out_direct，in，out_callback)
CallAuthority	object	通話権限
CallType	string	通話タイプ(着信,発信,三方通話,相談等)

14. 転送

基本情報

メソッド名：Transferred

概要

転送の監視イベント

例

呼び出し

UdeskCCPaasApiClassInstance.on("Transferred",function(resp){})

レスポンス

{
    Code: "0000",
    Data: {
        CallID: "",
        AgentInfo: {},
        CustomerInfo: {},
        FromQueue: "",
        DisplayNum: undefined,
        WorkFlow: "",
        CallAuthority: "",
        CallType: "",
    },
    Message: "",
    Visible: false
}

リクエストパラメータ

なし

返却データ

名称	タイプ	説明
promise	promise	成功・失敗コールバック（失敗コールバックパラメータ：Message、Code、Data、Visible）

返却データ説明

名称	タイプ	説明
CallID	string	callId
AgentInfo	object	エージェント情報,{City}
CustomerInfo	object	顧客情報,,{City,Number}
FromQueue	string	コールソース
DisplayNum	string	発信者番号表示
WorkFlow	string	コール方向( out_direct、in、out_callback)
CallAuthority	object	コール権限
CallType	string	コールタイプ(着信、発信、三者通話、コンサルテーション等)

Keys	Action
`?`	Open this help
`n`	Next page
`p`	Previous page
`s`	Search

CCPaaSフロントエンドSDK API V2.1.0

一、基本的な使用方法

二、注意事項

ブラウザ互換性

AppDataProvider Classの使用方法

三、SDKの初期化と破棄

インスタンスの初期化

インスタンスの破棄

四、UdeskCCPaasApiClass インスタンス パラメータ説明

メソッド

用語説明

戻り値パラメータ説明

websocket接続

1.websocket接続を切断する

基本情報

概要

例

呼び出し

リクエストパラメータ

戻りデータ

2.websocketに接続する

基本情報

概要

例

呼び出し

レスポンス

リクエストパラメータ

戻りデータ

発信関連

01.電話をかける

基本情報

概要

例

呼び出し

レスポンス

リクエストパラメータ

02. 通話を切断する

基本情報

概要

サンプル

呼び出し

レスポンス

リクエストパラメータ

返却データ

03. 通話に応答する

基本情報

概要

サンプル

呼び出し

レスポンス

リクエストパラメータ

返却データ

04. デバイスモードを設定する

基本情報

概要

サンプル

呼び出し

レスポンス

リクエストパラメータ

パラメータ説明

返却データ

05. デバイスモードの取得

基本情報

概要

サンプル

呼び出し

レスポンス

リクエストパラメータ

返却データ

06. 全エージェント状態の取得

基本情報

概要

サンプル

呼び出し

レスポンス

リクエストパラメータ

レスポンスデータ

07. エージェントステータスを設定

基本情報

概要

四、UdeskCCPaasApiClass インスタンスパラメータ説明