Change Updates

Do not miss any Proxy API changes, ever again

Subscribe to the Proxy API changelog to be up to date on recent changes.

RSS

21 days ago

main
1.0.0
Compare
1.0.0

API structure has changed

Next change
25 structure changes including:
5 Breaking changes
20 Modifications
5 Removals
Modified 20 Breaking
DELETE /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}
  • Response
  • 204 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
GET /v1/Services
  • Response
  • 200 response Modified
    • application/json content type Modified
      • services property Modified
        • default_ttl property Modified
          • Type went from integer | null to integer
            Breaking
        • number_selection_behavior, geo_match_level properties Modified
          • Type went from string | null to string
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ServiceSid}/PhoneNumbers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • phone_numbers property Modified
        • in_use property Modified
          • Type went from integer | null to integer
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ServiceSid}/PhoneNumbers/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • in_use property Modified
        • Type went from integer | null to integer
          Breaking
GET /v1/Services/{ServiceSid}/Sessions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • sessions property Modified
        • status, mode properties Modified
          • Type went from string | null to string
            Breaking
        • ttl property Modified
          • Type went from integer | null to integer
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • interactions property Modified
        • type, inbound_resource_status, outbound_resource_status properties Modified
          • Type went from string | null to string
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type, inbound_resource_status, outbound_resource_status properties Modified
        • Type went from string | null to string
          Breaking
GET /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • interactions property Modified
        • type, inbound_resource_status, outbound_resource_status properties Modified
          • Type went from string | null to string
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type, inbound_resource_status, outbound_resource_status properties Modified
        • Type went from string | null to string
          Breaking
GET /v1/Services/{ServiceSid}/Sessions/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • status, mode properties Modified
        • Type went from string | null to string
          Breaking
      • ttl property Modified
        • Type went from integer | null to integer
          Breaking
GET /v1/Services/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • default_ttl property Modified
        • Type went from integer | null to integer
          Breaking
      • number_selection_behavior, geo_match_level properties Modified
        • Type went from string | null to string
          Breaking
POST /v1/Services
  • Response
  • 201 response Modified
    • application/json content type Modified
      • default_ttl property Modified
        • Type went from integer | null to integer
          Breaking
      • number_selection_behavior, geo_match_level properties Modified
        • Type went from string | null to string
          Breaking
POST /v1/Services/{ServiceSid}/PhoneNumbers
  • Response
  • 201 response Modified
    • application/json content type Modified
      • in_use property Modified
        • Type went from integer | null to integer
          Breaking
POST /v1/Services/{ServiceSid}/PhoneNumbers/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • in_use property Modified
        • Type went from integer | null to integer
          Breaking
POST /v1/Services/{ServiceSid}/Sessions
  • Body
  • application/x-www-form-urlencoded content type Modified
    • FailOnParticipantConflict property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 201 response Modified
    • application/json content type Modified
      • status, mode properties Modified
        • Type went from string | null to string
          Breaking
      • ttl property Modified
        • Type went from integer | null to integer
          Breaking
POST /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants
  • Body
  • application/x-www-form-urlencoded content type Modified
    • FailOnParticipantConflict property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions
  • Response
  • 201 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
POST /v1/Services/{ServiceSid}/Sessions/{Sid}
  • Body
  • application/x-www-form-urlencoded content type Modified
    • FailOnParticipantConflict property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • status, mode properties Modified
        • Type went from string | null to string
          Breaking
      • ttl property Modified
        • Type went from integer | null to integer
          Breaking
POST /v1/Services/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • default_ttl property Modified
        • Type went from integer | null to integer
          Breaking
      • number_selection_behavior, geo_match_level properties Modified
        • Type went from string | null to string
          Breaking
Removed 5 Breaking
DELETE /v1/Services/{ServiceSid}/ShortCodes/{Sid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/Services/{ServiceSid}/ShortCodes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/Services/{ServiceSid}/ShortCodes/{Sid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/Services/{ServiceSid}/ShortCodes
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/Services/{ServiceSid}/ShortCodes/{Sid}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking