openapi-directory/api/amazonaws.com/sms-voice.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"version":"2018-09-05","x-release":"v4","title":"Amazon Pinpoint SMS and Voice Service","description":"Pinpoint SMS and Voice Messaging public facing APIs","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"sms-voice","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/sms-voice-2018-09-05.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-direct":true}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://aws.amazon.com/pinpoint/"},"security":[{"hmac":[]}],"paths":{"/v1/sms-voice/configuration-sets":{"post":{"operationId":"CreateConfigurationSet","description":"Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConfigurationSetResponse"}}}},"480":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}},"484":{"description":"AlreadyExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlreadyExistsException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConfigurationSetRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListConfigurationSets","description":"List all of the configuration sets associated with your Amazon Pinpoint account in the current region.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConfigurationSetsResponse"}}}},"480":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConfigurationSetsRequest"}}},"required":true}}},"/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations":{"post":{"operationId":"CreateConfigurationSetEventDestination","description":"Create a new event destination in a configuration set.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConfigurationSetEventDestinationResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"482":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"485":{"description":"AlreadyExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlreadyExistsException"}}}}},"parameters":[{"name":"ConfigurationSetName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConfigurationSetEventDestinationRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetConfigurationSetEventDestinations","description":"Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigurationSetEventDestinationsResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[{"name":"ConfigurationSetName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigurationSetEventDestinationsRequest"}}},"required":true}}},"/v1/sms-voice/configuration-sets/{ConfigurationSetName}":{"delete":{"operationId":"DeleteConfigurationSet","description":"Deletes an existing configuration set.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteConfigurationSetResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[{"name":"ConfigurationSetName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteConfigurationSetRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}":{"delete":{"operationId":"DeleteConfigurationSetEventDestination","description":"Deletes an event destination in a configuration set.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteConfigurationSetEventDestinationResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[{"name":"ConfigurationSetName","in":"path","required":true,"schema":{"type":"string"}},{"name":"EventDestinationName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteConfigurationSetEventDestinationRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"put":{"operationId":"UpdateConfigurationSetEventDestination","description":"Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConfigurationSetEventDestinationResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"483":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[{"name":"ConfigurationSetName","in":"path","required":true,"schema":{"type":"string"}},{"name":"EventDestinationName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConfigurationSetEventDestinationRequest"}}},"required":true}}},"/v1/sms-voice/voice/message":{"post":{"operationId":"SendVoiceMessage","description":"Create a new voice message and send it to a recipient's phone number.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendVoiceMessageResponse"}}}},"480":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendVoiceMessageRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"servers":[{"url":"https://sms-voice.pinpoint.amazonaws.com/"},{"url":"http://sms-voice.pinpoint.amazonaws.com/"}],"components":{"parameters":{"Action":{"name":"Action","in":"query","required":true,"schema":{"type":"string"}},"Version":{"name":"Version","in":"query","required":true,"schema":{"type":"string"}},"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","required":false,"schema":{"type":"string"}}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"CreateConfigurationSetResponse":{"type":"object","properties":{},"description":"An empty object that indicates that the configuration set was successfully created."},"CreateConfigurationSetRequest":{"type":"object","properties":{"ConfigurationSetName":{"$ref":"#/components/schemas/WordCharactersWithDelimiters"}},"description":"A request to create a new configuration set."},"TooManyRequestsException":{},"BadRequestException":{},"LimitExceededException":{},"InternalServiceErrorException":{},"AlreadyExistsException":{},"CreateConfigurationSetEventDestinationResponse":{"type":"object","properties":{},"description":"An empty object that indicates that the event destination was created successfully."},"CreateConfigurationSetEventDestinationRequest":{"type":"object","properties":{"EventDestination":{"$ref":"#/components/schemas/EventDestinationDefinition"},"EventDestinationName":{"$ref":"#/components/schemas/NonEmptyString"}},"description":"Create a new event destination in a configuration set."},"NotFoundException":{},"DeleteConfigurationSetResponse":{"type":"object","properties":{},"description":"An empty object that indicates that the configuration set was deleted successfully."},"DeleteConfigurationSetRequest":{"type":"object","properties":{}},"DeleteConfigurationSetEventDestinationResponse":{"type":"object","properties":{},"description":"An empty object that indicates that the event destination was deleted successfully."},"DeleteConfigurationSetEventDestinationRequest":{"type":"object","properties":{}},"GetConfigurationSetEventDestinationsResponse":{"type":"object","properties":{"EventDestinations":{"$ref":"#/components/schemas/EventDestinations"}},"description":"An object that contains information about an event destination."},"GetConfigurationSetEventDestinationsRequest":{"type":"object","properties":{}},"ListConfigurationSetsResponse":{"type":"object","properties":{"ConfigurationSets":{"$ref":"#/components/schemas/ConfigurationSets"},"NextToken":{"$ref":"#/components/schemas/NextTokenString"}},"description":"An object that contains information about the configuration sets for your account in the current region."},"ListConfigurationSetsRequest":{"type":"object","properties":{}},"SendVoiceMessageResponse":{"type":"object","properties":{"MessageId":{"$ref":"#/components/schemas/String"}},"description":"An object that that contains the Message ID of a Voice message that was sent successfully."},"SendVoiceMessageRequest":{"type":"object","properties":{"CallerId":{"$ref":"#/components/schemas/String"},"ConfigurationSetName":{"$ref":"#/components/schemas/WordCharactersWithDelimiters"},"Content":{"$ref":"#/components/schemas/VoiceMessageContent"},"DestinationPhoneNumber":{"$ref":"#/components/schemas/NonEmptyString"},"OriginationPhoneNumber":{"$ref":"#/components/schemas/NonEmptyString"}},"description":"SendVoiceMessageRequest"},"UpdateConfigurationSetEventDestinationResponse":{"type":"object","properties":{},"description":"An empty object that indicates that the event destination was updated successfully."},"UpdateConfigurationSetEventDestinationRequest":{"type":"object","properties":{"EventDestination":{"$ref":"#/components/schemas/EventDestinationDefinition"}},"description":"UpdateConfigurationSetEventDestinationRequest"},"Boolean":{"type":"boolean"},"NonEmptyString":{"type":"string"},"CallInstructionsMessageType":{"type":"object","properties":{"Text":{"$ref":"#/components/schemas/NonEmptyString"}},"description":"An object that defines a message that contains text formatted using Amazon Pinpoint Voice Instructions markup."},"String":{"type":"string"},"CloudWatchLogsDestination":{"type":"object","properties":{"IamRoleArn":{"$ref":"#/components/schemas/String"},"LogGroupArn":{"$ref":"#/components/schemas/String"}},"description":"An object that contains information about an event destination that sends data to Amazon CloudWatch Logs."},"WordCharactersWithDelimiters":{"type":"string"},"ConfigurationSets":{"type":"array","description":"An array that contains all of the configuration sets in your Amazon Pinpoint account in the current AWS Region.","items":{"$ref":"#/components/schemas/WordCharactersWithDelimiters"}},"__string":{"type":"string"},"EventDestinationDefinition":{"type":"object","properties":{"CloudWatchLogsDestination":{"$ref":"#/components/schemas/CloudWatchLogsDestination"},"Enabled":{"$ref":"#/components/schemas/Boolean"},"KinesisFirehoseDestination":{"$ref":"#/components/schemas/KinesisFirehoseDestination"},"MatchingEventTypes":{"$ref":"#/components/schemas/EventTypes"},"SnsDestination":{"$ref":"#/components/schemas/SnsDestination"}},"description":"An object that defines a single event destination."},"KinesisFirehoseDestination":{"type":"object","properties":{"DeliveryStreamArn":{"$ref":"#/components/schemas/String"},"IamRoleArn":{"$ref":"#/components/schemas/String"}},"description":"An object that contains information about an event destination that sends data to Amazon Kinesis Data Firehose."},"EventTypes":{"type":"array","description":"An array of EventDestination objects. Each EventDestination object includes ARNs and other information that define an event destination.","items":{"$ref":"#/components/schemas/EventType"}},"SnsDestination":{"type":"object","properties":{"TopicArn":{"$ref":"#/components/schemas/String"}},"description":"An object that contains information about an event destination that sends data to Amazon SNS."},"EventDestination":{"type":"object","properties":{"CloudWatchLogsDestination":{"$ref":"#/components/schemas/CloudWatchLogsDestination"},"Enabled":{"$ref":"#/components/schemas/Boolean"},"KinesisFirehoseDestination":{"$ref":"#/components/schemas/KinesisFirehoseDestination"},"MatchingEventTypes":{"$ref":"#/components/schemas/EventTypes"},"Name":{"$ref":"#/components/schemas/String"},"SnsDestination":{"$ref":"#/components/schemas/SnsDestination"}},"description":"An object that defines an event destination."},"EventDestinations":{"type":"array","description":"An array of EventDestination objects. Each EventDestination object includes ARNs and other information that define an event destination.","items":{"$ref":"#/components/schemas/EventDestination"}},"EventType":{"type":"string","enum":["INITIATED_CALL","RINGING","ANSWERED","COMPLETED_CALL","BUSY","FAILED","NO_ANSWER"],"description":"The types of events that are sent to the event destination."},"NextTokenString":{"type":"string"},"PlainTextMessageType":{"type":"object","properties":{"LanguageCode":{"$ref":"#/components/schemas/String"},"Text":{"$ref":"#/components/schemas/NonEmptyString"},"VoiceId":{"$ref":"#/components/schemas/String"}},"description":"An object that defines a message that contains unformatted text."},"SSMLMessageType":{"type":"object","properties":{"LanguageCode":{"$ref":"#/components/schemas/String"},"Text":{"$ref":"#/components/schemas/NonEmptyString"},"VoiceId":{"$ref":"#/components/schemas/String"}},"description":"An object that defines a message that contains SSML-formatted text."},"VoiceMessageContent":{"type":"object","properties":{"CallInstructionsMessage":{"$ref":"#/components/schemas/CallInstructionsMessageType"},"PlainTextMessage":{"$ref":"#/components/schemas/PlainTextMessageType"},"SSMLMessage":{"$ref":"#/components/schemas/SSMLMessageType"}},"description":"An object that contains a voice message and information about the recipient that you want to send it to."}}}}