CXML Scripts

Retrieve a cXML Script

Retrieves one stored cXML script by LamlBin SID. The same script can be read with Get cXML Script, which addresses it by resource ID rather than SID.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice or Messaging or Fax.

Learn more about API scopes.

get/Accounts/{AccountSid}/LamlBins/{Sid}

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The unique identifier for the account this script is associated with.

Sidstring uuid required

Universal Unique Identifier.

The unique identifier of the cXML script.

Response

The request has succeeded.

sidstring uuid required

Universal Unique Identifier.

date_createdstring required

The date and time, in ISO 8601 format, the script was created.

date_updatedstring required

The date and time, in ISO 8601 format, the script was updated.

date_last_accessedstring nullable required

The date and time, in ISO 8601 format, the script was last accessed, or null if never accessed.

account_sidstring uuid required

Universal Unique Identifier.

namestring required

A friendly name given to the cXML script.

contentsstring required

The contents of the cXML script.

request_urlstring uri required

The unique URL to the raw contents of the cXML script.

num_requestsinteger required

The number of times this cXML script has been accessed.

api_versionstring required

The version of the SignalWire API.

uristring required

The URL of this resource.

Example response

{
  "date_created": "2019-11-26T20:00:00Z",
  "date_updated": "2019-11-26T20:00:00Z",
  "date_last_accessed": "2020-06-05T20:00:00Z",
  "name": "Death Star IVR",
  "contents": "<Response><Say>Hello!</Say></Response>",
  "request_url": "https://example.signalwire.com/laml-bins/5184b831-184f-4209-872d-ccdccc80f2f1",
  "num_requests": 42,
  "api_version": "2010-04-01",
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/LamlBins/5184b831-184f-4209-872d-ccdccc80f2f1"
}

Changes

Changed in 8 of the 40 revisions of this API.625

  • 2916d5e3072e22See the full diff
    • the account_sid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • the sid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • added uuid to the account_sid response property allOf list for the response status 200

      response-property-all-of-added

    • added uuid to the sid response property allOf list for the response status 200

      response-property-all-of-added

    • added 'unevaluatedProperties' constraint to the response body for the status 200

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the response body for the status 400

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the response body for the status 401

      response-body-unevaluated-properties-added

    • added 'unevaluatedProperties' constraint to the response body for the status 404

      response-body-unevaluated-properties-added

    • response property date_last_accessed list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • api tag CXML Scripts added

      api-tag-added

    • api tag cXML Scripts removed

      api-tag-removed

    • api operation id retrieve_cxml_application removed and replaced with retrieve_cxml_script

      api-operation-id-removed

    • added the non-success response with the status 400

      response-non-success-status-added

  • d5fbaaddfa3e113See the full diff
    • the response property date_last_accessed became nullable for the status 200

      response-property-became-nullable

    • api tag cXML Scripts added

      api-tag-added

    • api tag cXML Bins removed

      api-tag-removed

    • the response property account_sid became required for the status 200

      response-property-became-required

    • the response property api_version became required for the status 200

      response-property-became-required

    • the response property contents became required for the status 200

      response-property-became-required

    • the response property date_created became required for the status 200

      response-property-became-required

    • the response property date_last_accessed became required for the status 200

      response-property-became-required

    • the response property date_updated became required for the status 200

      response-property-became-required

    • the response property name became required for the status 200

      response-property-became-required

    • the response property request_url became required for the status 200

      response-property-became-required

    • the response property sid became required for the status 200

      response-property-became-required

    • the response property uri became required for the status 200

      response-property-became-required

    • added the required property num_requests to the response with the 200 status

      response-required-property-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3c88f14db21e22See the full diff
    • added the new path request parameter AccountSid

      new-request-path-parameter

    • added the new path request parameter Sid

      new-request-path-parameter

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 404

      response-non-success-status-added

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog