Amazon Web Services, Inc.

Amazon Pinpoint SMS and Voice Service

Pinpoint SMS and Voice Messaging public facing APIs

Communication#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Pinpoint SMS and Voice Messaging public facing APIs

Endpoints 8

  • GETList configuration sets/v1/sms-voice/configuration-sets?NextToken=string&PageSize=stringList all of the configuration sets associated with your Amazon Pinpoint account in the current region.
  • POSTCreate configuration set/v1/sms-voice/configuration-setsCreate a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
  • GETGet configuration set event destinations/v1/sms-voice/configuration-sets/:ConfigurationSetName/event-destinationsObtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of…
  • POSTCreate configuration set event destination/v1/sms-voice/configuration-sets/:ConfigurationSetName/event-destinationsCreate a new event destination in a configuration set.
  • DELETEDelete configuration set/v1/sms-voice/configuration-sets/:ConfigurationSetNameDeletes an existing configuration set.
  • PUTUpdate configuration set event destination/v1/sms-voice/configuration-sets/:ConfigurationSetName/event-destinations/:EventDestinationNameUpdate an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example,…
  • DELETEDelete configuration set event destination/v1/sms-voice/configuration-sets/:ConfigurationSetName/event-destinations/:EventDestinationNameDeletes an event destination in a configuration set.
  • POSTSend voice message/v1/sms-voice/voice/messageCreate a new voice message and send it to a recipient's phone number.

API details

Base URL
https://sms-voice.pinpoint.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
8 operations on 5 pathsPOST 3GET 2DELETE 2PUT 1
Description format
AWS Smithy model, API version 2018-09-05

How to test the Amazon Pinpoint SMS and Voice Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Pinpoint SMS and Voice Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List configuration sets” (GET /v1/sms-voice/configuration-sets?NextToken=string&PageSize=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Pinpoint SMS and Voice Service?

Pinpoint SMS and Voice Messaging public facing APIs It is listed under Communication and has 8 endpoints.

Who publishes the Amazon Pinpoint SMS and Voice Service?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Pinpoint SMS and Voice Service?

Requests go to https://sms-voice.pinpoint.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Pinpoint SMS and Voice Service?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Pinpoint SMS and Voice Service have?

8 operations on 5 paths (3 POST, 2 GET, 2 DELETE, 1 PUT).

Is forking the Amazon Pinpoint SMS and Voice Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.