ModifyChimeMeetingAttendee (オーディオのミュートとミュート解除） - Amazon Chime SDK

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ModifyChimeMeetingAttendee (オーディオのミュートとミュート解除）

Amazon Chime SDK の会議 ID および出席者リストを提供することで、SIP メディアアプリケーションがテレフォニー出席者のステータスを変更できるようにします。

注記

このアクションは現在、テレフォニー出席者に対するミュート操作およびミュート解除操作をサポートしています。また、ユーザーは、JoinChimeMeeting アクションを使用して会議に参加する必要があります。このアクションは、participantTag=“LEG-B” に対して、または対応する CallId に対して実行できます。

このアクションが適用されるのは、SIP メディアアプリケーションから "+13605550122" に参加する callLeg、LEG-B、または SIP メディアアプリケーションから会議に参加するレッグのみです。

{
"SchemaVersion": "1.0",
  "Actions": [
    {
      "Type" : "ModifyChimeMeetingAttendees",
      "Parameters" : {
        "Operation": "Mute",
        "MeetingId": "meeting-id",
        "CallId": "call-id",
        "ParticipantTag": LEG-B",
        "AttendeeList": ["attendee-id-1", "attendee-id-2"]
      }
    }
  ]
}
Operation

説明 - 出席者リストに対して実行する操作

使用できる値 – Mute、Unmute

必須 – はい

デフォルト値 – なし

MeetingId

説明 - 出席者が属する会議の ID

使用できる値 – 有効な会議 ID ミュートまたはミュート解除するユーザーも会議に属している必要があります。

必須 – はい

デフォルト値 – なし

CallId

説明 - 出席者が属する会議の ID

使用できる値 – 有効な通話 ID。

必須 – いいえ

デフォルト値 – なし

ParticipantTag

説明 - 出席者に割り当てられたタグ

使用できる値 - 有効なタグ

必須 – いいえ

デフォルト値 – なし

AttendeeList

説明 - ミュートまたはミュート解除する出席者 ID のリスト

使用できる値 - 有効な出席者 ID のリスト

必須 – はい

デフォルト値 - なし、最大 100 件

このアクションを実行すると、Audio Service は常に、ACTION_SUCCESSFUL または ACTION_FAILED 呼び出しイベントタイプの AWS Lambda 関数を呼び出します。次のコード例は、一般的な ACTION_SUCCESSFUL 呼び出しイベントを示しています。

{
    "SchemaVersion": "1.0",
    "Sequence": INTEGER,
    "InvocationEventType": "ACTION_SUCCESSFUL",
    "ActionData": {
        "Type" : "ModifyChimeMeetingAttendees",
        "Parameters" : {
            "Operation": "Mute",
            "MeetingId": "meeting-id",
            "CallId": "call-id",
            "ParticipantTag": "LEG-B",
            "AttendeeList": ["attendee-id-1", "attendee-id-2"]
        }
    }
    "CallDetails": {
        ...
    }
}
エラー処理

無効な命令パラメータまたは API 障害が発生した場合、SIP メディアアプリケーションは、失敗した命令または API に固有のエラーメッセージを含む AWS Lambda 関数を呼び出します。

エラー メッセージ 理由

InvalidActionParameter

ModifyChimeMeetingAttendees Operation パラメータの値が無効です。

Operation 値は Mute または Unmute でなければなりません。

会議 ID のパラメータ値が無効です。

会議 ID が空です。

出席者リストのパラメータ値が無効です。

出席者 ID リストが空か、上限の 100 件を超えています。

通話中のアクションが無効です。

通話がブリッジされていません。

通話が Chime Meeting に接続されていません。

出席者が Chime Meeting に接続されていません。

One or more attendees are not part of this meeting. All attendees must be part of this meeting.

この出席者には、会議の出席者を変更する権限がありません。

SystemException

アクションの実行中にシステムエラーが発生しました。

アクションの実行中に、システムエラーが発生しました。

次のコード例は、一般的な失敗イベントを示しています。

{
    "SchemaVersion": "1.0",
    "Sequence": INTEGER,
    "InvocationEventType": "ACTION_FAILED",
    "ActionData": {
        "Type" : "ModifyChimeMeetingAttendees",
        "Parameters" : {
            "Operation": "Mute",
            "MeetingId": "meeting-id",
            "CallId": "call-id",
            "ParticipantTag": "LEG-B",
            "AttendeeList": ["attendee-id-1", "attendee-id-2"]
        },
        "ErrorType": "",
        "ErrorMessage": "",
        "ErrorList": []
    }
    "CallDetails": {
        ...
    }
}

の作業例を参照してください GitHub。