Service

Get service configuration

Gets configuration specific to the type of automated service.

Only certain types of services provide their configuration via the API. See Service Configuration Reference or the machine-readable OpenAPI specification for available configuration options.

Response Schema: The response object structure depends on the service's service_type:

  • incoming_message_actions: Returns ServiceConfigIncomingMessageActions
  • contact_actions: Returns ServiceConfigContactActions
  • message_actions: Returns ServiceConfigMessageActions
  • project_actions: Returns ServiceConfigProjectActions
  • message_status_actions: Returns ServiceConfigMessageStatusActions
  • voice_actions: Returns ServiceConfigVoiceActions
  • ussd_actions: Returns ServiceConfigUssdActions
  • data_row_actions: Returns ServiceConfigDataRowActions
  • incoming_message_webhook: Returns ServiceConfigIncomingMessageWebhook
  • optin_optout: Returns ServiceConfigOptinOptout
  • keyword_auto_reply: Returns ServiceConfigKeywordAutoReply
  • messaging_poll: Returns ServiceConfigMessagingPoll
  • voice_poll: Returns ServiceConfigVoicePoll
  • scheduled_actions: Returns ServiceConfigScheduledActions
  • auto_reply: Returns ServiceConfigAutoReply
  • call_auto_reply: Returns ServiceConfigCallAutoReply
  • *_script types: Returns ServiceConfigScript (code)
  • opt_out_page: Returns ServiceConfigOptOutPage
  • button_page: Returns ServiceConfigButtonPage
  • custom_template_instance: Returns ServiceConfigCustomTemplateInstance

See x-service-types in the API info section for complete schema details.

Cloud Script API Reference: For comprehensive documentation of the JavaScript functions and objects available within Cloud Script services, see the TypeScript declarations at https://api.telerivet.com/script.d.ts.

get/v1/projects/{project_id}/services/{id}/config

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/services/{id}/config
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://telerivet.com/oauth/authorize, token URL https://api.telerivet.com/oauth/token)

Path parameters

project_idstring required

ID of the Project

idstring required

ID of the Service

Response

Service configuration object (structure depends on service_type)

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "actions": [
    {
      "type": "reply",
      "body": {
        "content": "Hello, [[contact.name]]."
      }
    }
  ],
  "subroutines": [
    {
      "actions": [
        {
          "type": "add_contact_to_group",
          "group_name": "subscribers"
        }
      ]
    }
  ],
  "response_handlers": [
    {
      "actions": [
        {
          "type": "reply",
          "body": {
            "content": "Hello, [[contact.name]]."
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.