Skip to main content

List omnichannel steps

GET 

/:organization_id/omnichannel_steps

Returns a paginated list of omnichannel steps for an organization

Request

Path Parameters

    organization_id integerrequired

    Organization ID

Query Parameters

    dialer_campaign_id integer

    Filter steps by dialer campaign ID

    page integer

    Page number for pagination

    Default value: 1
    per_page integer

    Number of items per page

    Default value: 20
    sort_by string

    Possible values: [order, channel, created_at, updated_at]

    Field to sort by

    Default value: order
    sort_order string

    Possible values: [asc, desc]

    Sort order (ascending or descending)

    Default value: asc

Responses

Successful response

Schema
    data object[]
  • Array [
  • idintegerrequired

    Unique identifier for the omnichannel step

    organization_idintegerrequired

    ID of the organization this step belongs to

    dialer_campaign_idintegerrequired

    ID of the dialer campaign this step belongs to

    orderintegerrequired

    Order/sequence of this step within the campaign

    channelstringrequired

    Communication channel to use for this step

    Possible values: [SMS, VOICE, EMAIL, LIVE_CHAT, FACEBOOK, APPLE_BUSINESS_CHAT, GOOGLE_BUSINESS_CHAT, WHATSAPP]

    retry_interval_secondsintegerrequired

    Time in seconds to wait before retrying this step

    delay_secondsintegerrequired

    Time in seconds to delay before executing this step

    max_attemptsintegerrequired

    Maximum number of attempts for this step

    created_atdate-time

    Creation timestamp

    updated_atdate-time

    Last update timestamp

  • ]
  • meta object
    pagination object
    current_pageinteger
    total_pagesinteger
    total_countinteger
    per_pageinteger

Authorization: http

name: basicAuthtype: httpscheme: basicdescription: Basic authentication using API key ID and API key
import http.client

conn = http.client.HTTPSConnection("cloud-staging.cloverhound.com")
payload = ''
headers = {
'Accept': 'application/json',
'Authorization': 'Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
}
conn.request("GET", "/:organization_id/omnichannel_steps", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
Request Collapse all
Auth
Parameters
— pathrequired
— query
— query
— query
— query
— query