Loading...

REST API


Base URL

https://api.3seventy.com/api/v2.1



Conventions

Some of the URLs in this documentaion contain placeholders for values that your API client program must provide. These placeholders are shown in curly braces, like {this}. When you construct the URL to access these resources, replace those placeholders with the values you want to use.

REST API Reference Index

Resource Description
/account Account API endpoint lets you work with the account and its list of subaccount details
/accountattribute Account Attribute endpoint lets you work with the list of Account Attributes for the account.
/accountattributecategory This endpoint provides details regarding different Account Attribute Categories.
/accountattributedefinition Account Attribute Defintion endpoint lets you create new Attribute definitions or modify existing Attribute definitions on an account
/accountimage Account Image endpoint lets you create new images or modify/delete exisitng images on an account
/action Action endpoint lets you retrive an action, activate a disabled action or vice versa, stop an action that has been pushed or scheduled in future.
/actionattachkeyword Action Attach keyword lets you retrive a list of actions that has keywords attached, attach a keyword to an action, stop an action from sending
/actionexecute Action Execute lets you to get a list of action executions, specific action execution log, lets you execute an action or lets you abort an action that has been initated.
/actionimportcontacts Action Import Contacts lets you retrive list of action imports, details of a specific import, trigger an import or stop current import or any scheduled import actions
/actionpushcampaign Action push campaign lets you retrive list of campaign pushes, create a new action campaign push or stop an action campaign push which is currently beind proceesed or being scheduled for future.
/actionpushvoicecall Allows you to make a voice call action from your LongCode to a phone number/list of phonenumbers or contacts/contactlist.
/actionschedule Action schedule lets you retrive list of schedules on an action, update/remove a specific action schedule or create a new action schedule.
/apikey Api Key lets you retrive list of available APi keys, get/update/create/delete a specific api key for the supplied account.
/audiocall Allows you to make an audio call from your LongCode and play an audio file (mp3 or wav formats only) to a valid phone number.
/bridgecalls Allows you to Bridge calls between two phone numbers using your Longcode.
/callback Callback lets you retrive list of callbacks, create/update/delete a specific callback for the supplied account.
/callforwarding Callforwarding endpoint lets you assaign a callforwarding number to a longcode, lets you update/delete the callforwarding number.
/callforwardingverification This endpoint validates the callforwarding number before its beign assigned.
/campaign Allows you to get a list of all capaigns on an account, create/edit/delete a specific campaign for the supplied account.
/campaignchat Allows you to create/edit/delete a specific chat campaign for the supplied account.
/campaigncoupondefinition Campaign Coupon definition lets you get a list or create/update a specific coupon definition attached to a campaign.
/campaigncoupondefinitionredemptions Returns statistics/details about a coupon campaign's redemption rates
/campaigndialog Gets the details of a campaign's dialog data if the campaign is a DIALOG type. Able to Create/Update a dialog with new details for a DIALOG campaign.
/campaignkeywords Gets all keywords on a campaign.
/campaignquestion Gets the details of a campaign's question if the campaign is a QUESTION type. Able to Create/Update question details for a QUESTION campaign.
/campaignquestionanswer Allows you to get a list of valid answers or a specific answer on a campaign. It lets you create/update/delete a specific answer on a question campaign.
/carrierlookup Allows you to lookup carrier info.
/channel Allows you to get a list of channels, or specific channel under an account.
/chathistory Returns the chat history for an account and all sub accounts. This endpoint only returns the last 30 days of chat logs. For logs dating further back, please contact support@3seventy.com for assistance.
/chatlog Allows you to get all chat conversations, or a specific conversation log entry by chat name. Allows you to update DisplayName Only.
/chatlogsearch Gets all chat conversations for specified account
/conferencecalls Allows you to join an existing conference call or create a new one.
/contact Allows you to Get a list of contacts, or Get/Create/Update/Delete a specific contact on an account.
/contactattribute Allows you to Get a list of contact attributes , or Get/Create/Update/Remove a specific contact attribute on a contact.
/contactattributecategory Lists all categories for contact attribute or Gets the details for a specific contact attribute category.
/contactattributedefinition Allows you to Get a list of Contact attribute definitions, or Get/Update/Delete a specific contact attribute definition to the supplied account Id.
/contactimportfailedreport Returns a detailed report on fully or partially failed contact import event
/contactimporttemplate Gets a CSV import template to use for the bulk contact import endpoint. Not all items are required for the import to work. The only required items are the AccountId, PhoneNumber, and Email attributes. Note that with the phone number and email, only one or the other is needed, but both columns MUST appear for the bulk import to work.
/contactkeyword Lists all keywords on a contact as a set of name value pairs.
/contactlist Allows you to Get all the contact lists , or Get/Update/Delete a specific contact list on a supplied account
/contactlistexecute Executes a contact list returning all of the contacts that match the defined filter.
/contactsearch Searches for a contact via a phone number or email address.
/contactsubscription Allows you to Get all the subscription to which a contact is opted into, or Get/Update/Delete a specific contact subscription detail.
/content Allows you to Get all the contents , or Get/Create/Update/Delete a specific content on a supplied account.
/contenttemplate Allows you to Get all the templates on a content group, or Get/Create/Update/Delete a specific template within a content group.
/couponoffer Allows you to Get/Create/Update/Delete a specific coupon offer on a supplied campaign.
/externalcouponcodes Allows you to Get all the external coupon codes associated with a perticular external coupon list, or Get/Delete a specific coupon code.
/externalcouponlist Allows you to Get all the external coupon list definition and their details, or let you Get/Update/Delete a specific external coupon list.
/filtergroup Allows you to Get a non hierarchical list of contact filter groups for the supplied contact list, or Get/Update a specific Filter Group Details
/keyword Allows you to Get list of all the keywords, or let you Get/Update/Delete a specific keyword for a supplied account.
/keywordcampaign Allows you to Get/Create/Delete campaign details of the specified keyword.
/keywordcontact Lists all contacts on a keyword as a set of name value pairs.
/link Allows you to Get all the links, or Get/Create/Delete a specific link for a supplied account.
/longcode Returns a list of usable long codes for the supplied account ID.
/redeemcoupon Allows you to redeem coupon code on a specific account.
/report Allows you to Get list of all available reports, or Runs a report and returns the details of that report. Note that the returned data may be different depending on which report is run.
/requesttn Lets you request a new phone number.
/searchfortn Lets you searches for available telephone numbers.
/subaccount Allows you to Get list of all the child accounts of a supplied sub account.
/subscriptioncontact Allows you to Get list of all the contacts that have opted into the subscription , or lets you optin or opt out of a specific subscription.
/user Allows you to Get list of all the users for the specified account, or Get/Create/Update/Delete a specific user under an account.
/userchattoken Allows you to Get list or a specific login token.
/userlock Allows you to access (un)lock history for the supplied login, or Lock/Unlock a specific use from being able to login.
/userpassword Allows you to change a user's password to the newly supplied password.
/voicecall Allows you to make a voice call from your LongCode to a valid phone number and will speak the provided sentance