View a markdown version of this page

JoinChimeMeeting - Amazon Chime SDK

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

JoinChimeMeeting

提供出席者加入權杖，以參加 Amazon Chime SDK 會議。若要這樣做，您可以對 CreateMeeting和 CreateAttendee APIs 進行 AWS SDK 呼叫，以取得權杖並在 動作中傳遞權杖。請參閱以下範例。

注意

您無法在橋接呼叫上執行此動作。

{
    "Type": "JoinChimeMeeting",
    "Parameters": {
        "JoinToken": "meeting-attendee-join-token",
        "CallId": "call-id-1",
        "ParticipantTag": "LEG-A",
        "MeetingId": "meeting-id"
    }
}
JoinToken

描述 – Amazon Chime SDK 會議出席者的有效聯結字符

允許的值 – 有效的聯結字符

必要 – 是

預設值 — 無

CallId

描述 – CallId AWS Lambda 函數調用 CallDetails 中的參與者描述

允許的值 – 有效的呼叫 ID

必要 – 否

預設值 — 無

ParticipantTag

描述 – ParticipantTag 中其中一個已連線參與者的描述 CallDetails

允許的值 – LEG-A

必要 – 否

預設值 – 如果您指定 ParticipantTag ，則叫用callLeg忽略的預設值 CallId

MeetingId

描述 – 與 相關聯的有效 Amazon Chime SDK 會議 IDJoinToken。如果會議是使用 Amazon Chime 命名空間中的 API 建立，則不需要會議 ID。如果會議是使用 Amazon Chime SDK 會議命名空間中的 API 建立的，則需要會議 ID。會議會使用用來建立會議的 API 端點加入。

允許的值 – 有效的會議 ID。

必要 – 否。

預設值 – 無。

SIP 媒體應用程式一律會在執行此動作後叫用 AWS Lambda 函數。它會傳回 ACTION_SUCCESSFUL或 ACTION_FAILED 叫用事件類型。下列範例顯示成功的調用事件結構。

{
    "SchemaVersion": "1.0",
    "Sequence": 4,
    "InvocationEvent": "ACTION_SUCCESSFUL",
    "ActionData": {
        "Type": "JoinChimeMeeting",
        "Parameters": {
            "JoinToken": "meeting-attendee-join-token",
            "CallId": "call-id-1"
            "ParticipantTag": "LEG-A"
        }
    }
    "CallDetails": {
        ...
    }
}
錯誤處理

當橋接會議時發生驗證錯誤時，SIP 應用程式會使用下表中顯示的其中一個錯誤訊息呼叫其 AWS Lambda 函數。

錯誤 訊息 Reason

InvalidActionParameter

JoinToken 參數值無效。

動作的任何其他參數無效或遺失。

SystemException

執行動作時發生系統錯誤。

執行 動作時發生另一種類型的系統錯誤。

下列範例顯示典型的失敗事件。

{
    "SchemaVersion": "1.0",
    "Sequence": 3,
    "InvocationEvent": "ACTION_FAILED",
    "ActionData": {
        "Type": "JoinChimeMeeting",
        "Parameters": {
            "JoinToken": "meeting-attendee-join-token",
            "CallId": "call-id-1",
            "ParticipantTag": "LEG-A"
        },
        "Error": "ErrorJoiningMeeting: Error while joining meeting."
    }
    "CallDetails": {
        ...
    }
}

請參閱 GitHub 上的工作範例：https：//https://github.com/aws-samples/amazon-chime-sma-update-call