Amazon Chime SDK Chime Sip Rules API

The Chime Sip Rules API from Amazon Chime SDK — 2 operation(s) for chime sip rules.

GitHub OpenAPI

Operations 5

POST /sip-rules Create Sip Rule #
GET /sip-rules List Sip Rules #
DELETE /sip-rules/{SipRuleId} Delete Sip Rule #
GET /sip-rules/{SipRuleId} Get Sip Rule #
PUT /sip-rules/{SipRuleId} Update Sip Rule #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-chime:amazon-chime-sip-rules-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-chime-sip-rules-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Chime SDK Meetings Sip Rules API
  version: '2021-07-15'
  description: Generated from AWS's published Smithy model for Amazon Chime SDK Meetings. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://voice-chime.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /sip-rules:
    post:
      operationId: CreateSipRule
      summary: Create Sip Rule
      description: Creates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger
        type. For more information about SIP rules, see Managing SIP media applications and rules in the Amazon Chime SDK
        Administrator Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSipRuleResponse'
        '403':
          description: AccessDeniedException; ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException; ResourceLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeConflictException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSipRuleRequest'
      tags:
      - Sip Rules
    get:
      operationId: ListSipRules
      summary: List Sip Rules
      description: Lists the SIP rules under the administrator's AWS account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSipRulesResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeBadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSipRulesRequest'
      tags:
      - Sip Rules
  /sip-rules/{SipRuleId}:
    delete:
      operationId: DeleteSipRule
      summary: Delete Sip Rule
      description: Deletes a SIP rule.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteSipRuleRequest'
      tags:
      - Sip Rules
    get:
      operationId: GetSipRule
      summary: Get Sip Rule
      description: Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSipRuleResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeBadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetSipRuleRequest'
      tags:
      - Sip Rules
    put:
      operationId: UpdateSipRule
      summary: Update Sip Rule
      description: Updates the details of the specified SIP rule.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSipRuleResponse'
        '400':
          description: BadRequestException; ResourceLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSipRuleRequest'
      tags:
      - Sip Rules
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: chime
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    CreateSipRuleRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the SIP rule.
        TriggerType:
          type: string
          enum:
          - ToPhoneNumber
          - RequestUriHostname
          description: The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
        TriggerValue:
          type: string
          description: If TriggerType is RequestUriHostname, the value can be the outbound host name of a Voice Connector.
            If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication
            specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname,
            or if the To header in the incoming SIP request matches the ToPhoneNumber value.
        Disabled:
          type: boolean
          description: Disables or enables a SIP rule. You must disable SIP rules before you can delete them.
        TargetApplications:
          type: array
          items:
            $ref: '#/components/schemas/SipRuleTargetApplication'
          description: List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region
            can be used.
      required:
      - Name
      - TriggerType
      - TriggerValue
      - TargetApplications
    CreateSipRuleResponse:
      type: object
      properties:
        SipRule:
          $ref: '#/components/schemas/SipRule'
    DeleteSipRuleRequest:
      type: object
      properties:
        SipRuleId:
          type: string
          description: The SIP rule ID.
      required:
      - SipRuleId
    GetSipRuleRequest:
      type: object
      properties:
        SipRuleId:
          type: string
          description: The SIP rule ID.
      required:
      - SipRuleId
    GetSipRuleResponse:
      type: object
      properties:
        SipRule:
          $ref: '#/components/schemas/SipRule'
    ListSipRulesRequest:
      type: object
      properties:
        SipMediaApplicationId:
          type: string
          description: The SIP media application ID.
        MaxResults:
          type: integer
          description: The maximum number of results to return in a single call. Defaults to 100.
        NextToken:
          type: string
          description: The token used to return the next page of results.
    ListSipRulesResponse:
      type: object
      properties:
        SipRules:
          type: array
          items:
            $ref: '#/components/schemas/SipRule'
          description: The list of SIP rules and details.
        NextToken:
          type: string
          description: The token used to return the next page of results.
    SipRule:
      type: object
      properties:
        SipRuleId:
          type: string
          description: A SIP rule's ID.
        Name:
          type: string
          description: A SIP rule's name.
        Disabled:
          type: boolean
          description: Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete
            it.
        TriggerType:
          type: string
          enum:
          - ToPhoneNumber
          - RequestUriHostname
          description: The type of trigger set for a SIP rule, either a phone number or a URI request host name.
        TriggerValue:
          type: string
          description: The value set for a SIP rule's trigger type. Either a phone number or a URI hostname.
        TargetApplications:
          type: array
          items:
            $ref: '#/components/schemas/SipRuleTargetApplication'
          description: The target SIP media application and other details, such as priority and AWS Region, to be specified
            in the SIP rule. Only one SIP rule per AWS Region can be provided.
        CreatedTimestamp:
          type: string
          format: date-time
          description: The time at which the SIP rule was created, in ISO 8601 format.
        UpdatedTimestamp:
          type: string
          format: date-time
          description: The time at which the SIP rule was updated, in ISO 8601 format.
    SipRuleTargetApplication:
      type: object
      properties:
        SipMediaApplicationId:
          type: string
          description: The ID of a rule's target SIP media application.
        Priority:
          type: integer
          description: The priority setting of a rule's target SIP media application.
        AwsRegion:
          type: string
          description: The AWS Region of a rule's target SIP media application.
    UpdateSipRuleRequest:
      type: object
      properties:
        SipRuleId:
          type: string
          description: The SIP rule ID.
        Name:
          type: string
          description: The new name for the specified SIP rule.
        Disabled:
          type: boolean
          description: The new value that indicates whether the rule is disabled.
        TargetApplications:
          type: array
          items:
            $ref: '#/components/schemas/SipRuleTargetApplication'
          description: The new list of target applications.
      required:
      - SipRuleId
      - Name
    UpdateSipRuleResponse:
      type: object
      properties:
        SipRule:
          $ref: '#/components/schemas/SipRule'
    VoiceChimeBadRequestException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeConflictException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeForbiddenException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeNotFoundException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeServiceFailureException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeServiceUnavailableException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeThrottledClientException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeUnauthorizedClientException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime-sdk-voice/service/2022-08-03/chime-sdk-voice-2022-08-03.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)