Twilio

Twilio Proxy v1

This is the public Twilio REST API.

Communication#openapi

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

This is the public Twilio REST API.

Endpoints 25

ProxyV1Interaction

  • GETRetrieve a list of Interactions for a given [Session](https://www.twilio.com/docs/proxy/api/session)./v1/Services/:ServiceSid/Sessions/:SessionSid/Interactions/:SidRetrieve a list of Interactions for a given Session.
  • DELETEDelete a specific Interaction./v1/Services/:ServiceSid/Sessions/:SessionSid/Interactions/:SidDelete a specific Interaction.
  • GETRetrieve a list of all Interactions for a Session. A maximum of 100 records will be returned per page./v1/Services/:ServiceSid/Sessions/:SessionSid/Interactions?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Interactions for a Session. A maximum of 100 records will be returned per page.

ProxyV1MessageInteraction

  • GETListMessageInteraction/v1/Services/:ServiceSid/Sessions/:SessionSid/Participants/:ParticipantSid/MessageInteractions?PageSize=1&Page=0&PageToken=string
  • POSTCreate a new message Interaction to send directly from your system to one [Participant](https://www.twilio.com/docs/proxy/api/participant). The `inbound` properties for the Interaction will always be empty./v1/Services/:ServiceSid/Sessions/:SessionSid/Participants/:ParticipantSid/MessageInteractionsCreate a new message Interaction to send directly from your system to one Participant. The inbound properties for the Interaction will always be empty.
  • GETFetchMessageInteraction/v1/Services/:ServiceSid/Sessions/:SessionSid/Participants/:ParticipantSid/MessageInteractions/:Sid

ProxyV1Participant

  • GETFetch a specific Participant./v1/Services/:ServiceSid/Sessions/:SessionSid/Participants/:SidFetch a specific Participant.
  • DELETEDelete a specific Participant. This is a soft-delete. The participant remains associated with the session and cannot be re-added. Participants are only permanently deleted when the [Session](https://www.twilio.com/docs/proxy/api/session) is deleted./v1/Services/:ServiceSid/Sessions/:SessionSid/Participants/:SidDelete a specific Participant. This is a soft-delete. The participant remains associated with the session and cannot be re-added. Participants are only…
  • GETRetrieve a list of all Participants in a Session./v1/Services/:ServiceSid/Sessions/:SessionSid/Participants?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Participants in a Session.
  • POSTAdd a new Participant to the Session/v1/Services/:ServiceSid/Sessions/:SessionSid/ParticipantsAdd a new Participant to the Session

ProxyV1PhoneNumber

  • GETRetrieve a list of all Phone Numbers in the Proxy Number Pool for a Service. A maximum of 100 records will be returned per page./v1/Services/:ServiceSid/PhoneNumbers?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Phone Numbers in the Proxy Number Pool for a Service. A maximum of 100 records will be returned per page.
  • POSTAdd a Phone Number to a Service's Proxy Number Pool./v1/Services/:ServiceSid/PhoneNumbersAdd a Phone Number to a Service's Proxy Number Pool.
  • GETFetch a specific Phone Number./v1/Services/:ServiceSid/PhoneNumbers/:SidFetch a specific Phone Number.
  • POSTUpdate a specific Proxy Number./v1/Services/:ServiceSid/PhoneNumbers/:SidUpdate a specific Proxy Number.
  • DELETEDelete a specific Phone Number from a Service./v1/Services/:ServiceSid/PhoneNumbers/:SidDelete a specific Phone Number from a Service.

ProxyV1Service

  • GETFetch a specific Service./v1/Services/:SidFetch a specific Service.
  • POSTUpdate a specific Service./v1/Services/:SidUpdate a specific Service.
  • DELETEDelete a specific Service./v1/Services/:SidDelete a specific Service.
  • GETRetrieve a list of all Services for Twilio Proxy. A maximum of 100 records will be returned per page./v1/Services?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Services for Twilio Proxy. A maximum of 100 records will be returned per page.
  • POSTCreate a new Service for Twilio Proxy/v1/ServicesCreate a new Service for Twilio Proxy

ProxyV1Session

  • GETFetch a specific Session./v1/Services/:ServiceSid/Sessions/:SidFetch a specific Session.
  • POSTUpdate a specific Session./v1/Services/:ServiceSid/Sessions/:SidUpdate a specific Session.
  • DELETEDelete a specific Session./v1/Services/:ServiceSid/Sessions/:SidDelete a specific Session.
  • GETRetrieve a list of all Sessions for the Service. A maximum of 100 records will be returned per page./v1/Services/:ServiceSid/Sessions?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Sessions for the Service. A maximum of 100 records will be returned per page.
  • POSTCreate a new Session/v1/Services/:ServiceSid/SessionsCreate a new Session

API details

Base URL
https://proxy.twilio.com
Authentication
HTTP Basic authentication (username and password)
Operations
25 operations on 12 pathsGET 12POST 8DELETE 5
Main resources
ProxyV1PhoneNumber 5ProxyV1Service 5ProxyV1Session 5ProxyV1Participant 4ProxyV1Interaction 3ProxyV1MessageInteraction 3
Response formats
application/json
Description format
OpenAPI 3.0.1, API version 1.0.0

How to test the Twilio Proxy v1 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 Twilio Proxy v1 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Retrieve a list of Interactions for a given [Session](https://www.twilio.com/docs/proxy/api/session).” (GET /v1/Services/:ServiceSid/Sessions/:SessionSid/Interactions/:Sid), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Twilio Proxy v1?

This is the public Twilio REST API. It is listed under Communication and has 25 endpoints.

Who publishes the Twilio Proxy v1?

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

What is the base URL of the Twilio Proxy v1?

Requests go to https://proxy.twilio.com. Endpoint paths are added to this base URL.

How do I authenticate with the Twilio Proxy v1?

With HTTP Basic authentication (username and password).

How many endpoints does the Twilio Proxy v1 have?

25 operations on 12 paths (12 GET, 8 POST, 5 DELETE). The largest groups are ProxyV1PhoneNumber, ProxyV1Service, ProxyV1Session, ProxyV1Participant.

Is forking the Twilio Proxy v1 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.