exotelpy.exotel.Exotel

class exotelpy.exotel.Exotel(sid, key, token, baseurl='https://api.exotel.com')

Object to initialize and interact with Exotel API

It holds the authentication details

Parameters:
  • sid (str) – Exotel Account SID

  • key (str) – API Key

  • token (str) – API Token

  • baseurl (str, optional) – Account Subdomain. Defaults to “https://api.exotel.com”.

__init__(sid, key, token, baseurl='https://api.exotel.com')

Methods

__init__(sid, key, token[, baseurl])

add_contacts_to_list(sids, list_id)

https://developer.exotel.com/api/campaigns-lists#add-contacts-to-a-list

create_campaign(caller_id, app_id[, from_, ...])

The parameter information is available at https://developer.exotel.com/api/campaigns#create-campaign

create_campaign_with_list(numbers, ...)

Slightly customized to create list with numbers passed as argument implicitly

create_contacts(numbers)

Create contacts

create_list(name[, tag, numbers])

Slightly modded implementation that takes number as arguments and add those numbers to list after creation

create_message_campaign(content_type, lists, ...)

Create SMS Campaign https://developer.exotel.com/api/sms-campaigns#create-sms-campaigns

create_message_campaign_with_list(numbers, ...)

Slightly customized to create list with numbers passed as argument implicitly

create_sms_campaign(content_type, lists, ...)

Deprecated

create_sms_campaign_with_list(numbers, ...)

Slightly customized to create list with numbers passed as argument implicitly https://developer.exotel.com/api/sms-campaigns#create-sms-campaigns

delete_campaign(campaign_id)

Delete a specific campaign

delete_contact(sid)

https://developer.exotel.com/api/campaigns-contacts#delete-a-contact

delete_contacts(sids)

Utility method for deleting multiple contact at once

delete_list(list_id)

Deletes a list

get_all_exophones()

Get a list of all the ExoPhone numbers that have been assigned to an account https://developer.exotel.com/api/exophones#list-exophones

get_bulk_campaign_details([offset, limit, ...])

Allows you to fetch bulk campaign details with sorting and searching capabilities https://developer.exotel.com/api/campaigns#bulk-campaign-details

get_bulk_lists([offset, limit, name, sort_by])

https://developer.exotel.com/api/campaigns-lists#getbulklists

get_bulk_sms_campaign_details([offset, ...])

https://developer.exotel.com/api/sms-campaigns#bulk-sms-campaign-details

get_campaign_call_details(campaign_id[, ...])

https://developer.exotel.com/api/campaigns#call-details-single-campaign

get_campaign_details(campaign_id)

Retrieve the details of a specific campaign in your account

get_contact_details(contact_id)

https://developer.exotel.com/api/campaigns-contacts#get-details-of-a-contact

get_exophone_details(exophone_sid)

Get the details of a specific ExoPhone number of an account

get_exophone_heartbeat(exophone_sid)

Get the details of a specific ExoPhone in your account including connectivity information

get_list_contacts(list_id[, limit, offset])

https://developer.exotel.com/api/campaigns-lists#get-contacts-in-a-list

get_list_details(list_id)

https://developer.exotel.com/api/campaigns-lists#get-details-of-a-list

get_sms_campaign_details(campaign_id)

Get details of the SMS Campaign https://developer.exotel.com/api/sms-campaigns#sms-campaigns-details

get_sms_campaign_sms_details(campaign_id[, ...])

https://developer.exotel.com/api/sms-campaigns#sms-details-single-campaign

get_sms_details(sms_sid)

https://developer.exotel.com/api/sms#sms-details

send_bulk_sms(from_, to, body[, ...])

https://developer.exotel.com/api/sms#send-bulk-static-sms