チャット認証の取得 - サポートなし
get
/crmRestApi/resources/11.13.18.05/chatAuthenticate/{authUserName}
リクエスト
パス・パラメータ
- authUserName(required): string
ログイン・ユーザーの一意の識別子。 この属性は必須です。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : chatAuthenticate-item-response
タイプ:
ソースを表示
object
-
applicationClassification: string
販売またはサービスなどの顧客対応のアプリケーション分類です。 この属性はオプションです。
-
assigneeId: string
この顧客対応に割り当てる提案されたリソースの一意の識別子。 この属性はオプションです。
-
authUserName: string
ログイン・ユーザーの一意の識別子。 この属性は必須です。
-
businessUnitOrgId: string
顧客対応リクエストが関連付けられているビジネス・ユニットの一意の識別子。 この属性はオプションです。
-
categoryId: string
顧客対応リクエストのカテゴリの一意の識別子。 この属性はオプションです。
-
chatPriority: string
他のチャット・インタラクションと比較した特定のチャット・インタラクションの優先度。 この属性はオプションです。 chatPriority値が大きいほど、チャット・ルーティングに使用されるチャットの対話優先度が高くなります。
-
chatSiteName: string
認証コールによって返されたチャネル・サーバーのサイトの名前。 これはレスポンス属性であり、クライアントで入力しないでください。
-
clientType: string
顧客対応を認証するユーザーのタイプ。 現在使用可能な値はCONSUMERです。 この属性は必須です。
-
contactId: string
顧客対応の認証を行うユーザーに関連付けられたパーティの一意の識別子。 この属性はオプションです。
-
customFields: string
この顧客対応の割当に使用されるカスタム・フィールドのキー値ペアを含むJSON文字列。 この属性はオプションです。
-
domain: string
認証コールによって返されたチャネル・サーバーのドメイン・アドレス。 これはレスポンス属性であり、クライアントで入力しないでください。
-
emailAddress: string
顧客対応の認証を行うユーザーのEメール・アドレス。 この属性はオプションです。
-
escalationLevel: string
チャット・インタラクションがエスカレーションされたレベル。 デフォルト値は0で、これはエスカレーションがないことを意味します。 この属性はサポートされていません。
-
firstName: string
インタラクションの認証を行うユーザーの名。 この属性はオプションです。
-
incidentAssigneeId: string
サービス・リクエスト、販売商談など、顧客対応に関連するエンティティに割り当てられるリソースの一意の識別子。この属性はサポートされていません。
-
incidentId: string
製品、サービス・リクエスト、販売機会など、顧客対応に関連するエンティティの一意の識別子。この属性はオプションです。
-
incidentName: string
製品、サービス・リクエスト、販売機会など、顧客対応に関連するエンティティの名前。この属性はオプションです。
-
incidentSeverityCode: string
サービス・リクエスト、販売商談など、顧客対応に関連するエンティティの重大度の参照コード。 この属性はオプションです。
-
incidentType: string
製品、サービス・リクエスト、販売機会など、顧客対応に関連するエンティティのタイプ。この属性はオプションです。
-
interfaceId: string
チャネル・サーバーとの相互作用で使用されるインタフェースの一意の識別子。 インタフェース識別子は、システム生成メッセージの言語を定義します。 この属性はオプションです。
-
inventoryItemId: string
在庫品目の一意の識別子。 製品を識別するために、inventoryOrgIdおよびprodGroupIdとともに使用されます。 この属性はオプションです。
-
inventoryOrgId: string
在庫組織の一意の識別子。 製品を識別するために、inventoryItemIdおよびprodGroupIdとともに使用されます。 この属性はオプションです。
-
jwt: string
認証コールによって返されたJSON Webトークン。 これはレスポンス属性であり、クライアントで入力しないでください。
-
lastName: string
顧客対応の認証を行うユーザーの姓。 この属性はオプションです。
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
mediaList: string
チャネル・タイプ名と、そのチャネルに対するエンド・ユーザーのマシン機能のエラー・リスト(オプション)の組合せである複合配列をエンコードするオプション属性。 チャネル・タイプ名の有効な値は、CHAT、VIDEOおよびCOBROWSEです。 ビデオ・チャネル・エラーの有効な値は、NO_CAMERA、NO_MICROPHONEおよびNO_SPEAKERSです。 他のチャネル・エラーの有効な値は、BROWSER_NOT_SUPPORTEDおよびINSECURE_ORIGINです。 配列内の複合要素はセミコロンで区切られ、エラーはカンマで区切られ、チャネル・タイプとその対応するエラーはコロンで区切られます。 例: ???mediaList??? : ???CHAT:NO_KEYBOARD;VIDEO:NO_CAMERA,NO_MICROPHONE???.
-
organizationId: string
顧客対応の認証を行うユーザーに関連付けられたアカウントの一意の識別子。 この属性はオプションです。
-
poolId: string
認証コールによって返されるチャネル・サーバーのプールの一意の識別子。 これはレスポンス属性であり、クライアントで入力しないでください。
-
preferredResources: string
顧客対応の割当先を決定する際にプリファレンスを与える必要があるリソースの一意の識別子のカンマ区切りリスト。 この属性はサポートされていません。
-
prodGroupId: string
製品グループの一意の識別子。 製品を識別するために、inventoryOrgIdおよびinventoryItemIdとともに使用されます。 この属性はオプションです。
-
productId: string
製品の一意の識別子。 この属性は使用されていません。
-
question: string
顧客対応リクエストの件名。
-
queueId: string
この顧客対応で使用される内部キューの一意の識別子。 この属性はオプションです。
-
resumeType: string
セッションを再開するかどうかを示します。 使用可能な値は、RESUMEおよびDO_NOT_RESUMEです。 この属性はオプションです。
-
skipAgentIds: string
顧客対応の割当先を決定するときに除外する必要があるリソースの一意の識別子のカンマ区切りリスト。 この属性はサポートされていません。
-
stripeCode: string
CRM、HRHD、ISRなど、顧客対応が属するアプリケーション。 この属性はオプションです。
-
visitorBrowserHistorySessionId: string
エンドユーザーのブラウザ履歴の一意の識別子は、この対話を処理しているエージェントへのエンドユーザーのページ訪問に関するインサイトを提供します。 この属性はサポートされていません。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object
-
href: string
タイトル:
hyperlink reference
関連リソースへのURI。 -
kind: string
タイトル:
kind
許可された値:[ "collection", "item", "describe", "other" ]
関連リソースの種類。 -
name: string
タイトル:
name
関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation
許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。