SDE_Messaging
The following operations are supported. For a formal definition, please review the Service Description.
-
AddAccount
Add a new Account (RESTRICTED ACCESS) -
AddDID
Add a new DID to Account (RESTRICTED ACCESS) -
AddShortCodeKeyword
Creates a keyword for a short code -
AutoCreateAccount
Add a new Account from a PMP API Key (RESTRICTED ACCESS) -
AutoCreateAccount2
Add a new Account from a PMP API Key (RESTRICTED ACCESS) -
AutoCreateAccount3
Add a new Account from a PMP API Key (RESTRICTED ACCESS) -
AutoCreateAccount4
Add a new Account from a PMP API Key (RESTRICTED ACCESS) -
AutoCreateAccount5
Add a new Account from a PMP API Key (RESTRICTED ACCESS) -
CheckKeyword
Checks the availability of a key word. A shared shortcode keyword may show as available, but is really not due another company owning the keyword. -
CheckToken
Check Token -
CreateBitlyShortLink
Creates a bit.ly link to the Encoded Url passed in. -
CreateShortLink
Creates a short link to a file or url. You can provide a reference for informational purposes or tracking. Pass in the file information or a url. Use Expirationdays=0 for no link expiration. -
CreateShortLink2
Creates a short link to a file or url. You can provide a reference for informational purposes or tracking. Pass in the file information or a url. Use Expirationdays=0 for no link expiration. -
CreateShortLink3
Creates a short link to a file or url and a bit.ly link to the created short link. You can provide a reference for informational purposes or tracking. Pass in the file information or a url. Use Expirationdays=0 for no link expiration. -
CreateToken
Create a new Token -
Dialer
Call a phone number and connect to PBX IVR. -
DialerWithUserID
Call a phone number and connect to PBX IVR. -
ForwardSMSFromSMSV1
Forwards an SMS Message from the legacy SMSV1 System -
GetAccountInfo
Get Account Info (RESTRICTED ACCESS) -
GetAccountInfoFromPMPKey
Get Account Info from PMP Key (RESTRICTED ACCESS) -
GetAuthorizedFromNumbers
Get the authorized phone numbers or extensions you are allowed to call from with the dialer. -
GetContacts
Get all contacts -
GetDIDs
Get DID's. -
GetDialerTransactions
Get Dialer transactional records from phone number. -
GetDialerTransactionsByDateRange
Get Dialer transactional records from date range. -
GetEmailByDateRange
Get Emails by date range. -
GetIVRDetailsByDateRange
MessageName="GetIVRTransDetails"
Get IVR transactional details from date range. -
GetIVRSummaryByDateRange
MessageName="GetIVRTransSummary"
Get IVR transactional summary from date range. -
GetIVRTransactionsByCallerID
Get all IVR transactions by callerid phone number -
GetIVRTransactionsByDateRange
Get IVR transactions by Date range -
GetImageInfo
Get Short URL info from ControllerID -
GetMsgConversation
Get all messages sent and received by phone number/short code -
GetMsgDetails
Get Details from msgid -
GetMsgReceipts
Get Message Carrier Receipts (DLR) from Long Code Message -
GetMsgsByDateRange
Get Messages by date range. -
GetMsgsByPhoneWebAPI
MessageName="GetMsgsByPhone"
Get all messages sent and received by phone number/short code. Used for web interface. TimeFrame is Recent=1, This Week=2, This Month=3, All=0 -
GetMsgsByPhoneNumber
Get all messages sent and received by phone number/short code -
GetMsgsByPhoneNumberAndDateRange
Get Messages by SMS phone number and date range. -
GetNotificationTemplate
Get a notification template by id -
GetNotificationTemplates
List the notification templates -
GetNotificationTemplatesByTypeID
List the notification templates by Type ID -
GetNotificationTemplatesByTypeName
List the notification templates by Type Name -
GetPMP_TEST
MessageName="GetPMP_Test" -
GetPhoneVerification
Get Telecom Carrier info from phone number -
GetPhoneVerification2
Verifies a phone number -
GetProviderDIDs
Get a list of DID's registered with the telco -
GetShortcodeKeywords
Gets the keywords for an assigned Shortcode -
GetSignalRClientKey
Get Push Messaging client key -
GetTMPInfo
Validates a TMP client by APIKey -
GetTemplateTypes
List the template types -
KeywordListByCompany
Lists the Shortcodes and keywords assigned to the APIKey company. -
SMSBulkNotify
Upload a batch of records to send SMS notifications to. The value needs to be a CSV formatted with Name,Phone,Msg.
Example:
Name,Phone,Msg
John Doe,19415551212,This is an automated nofication. -
SendEmail
Sends an email from any email address -
SendEmailFromDealer
Sends an email from the dealer's email address on file (ReplyToEmail). -
SendSMS
Send an SMS (Text Message) to a smart device. -
SendSMSAttachment
Sends an SMS with an attachment. Attachment can be a file or Url and will convert attachment to short url. MsgTemplate can be used to embed the attachment. MsgTemplate ex: 'Click @smsurl for more information' -
SendSMSFromNumber
Send an SMS (Text Message) to a smart device including a user id for tracking purposes. Allows you to use any of the customer's DID's/Short Code for outbound. -
SendSMSFromShortCode
Send an SMS (Text Message) to a smart device including a user id for tracking purposes. Allows you to use any of the customer's Short Code for outbound. -
SendSMSWithTemplate
Send an SMS (Text Message) to a smart device including a user id for tracking purposes.
To pass in the template parameters, use [parameter]=[value] separated by ';'.
Example: Amount=124.52;DueDate=5/24/2014. -
SendSMSWithUserID
Send an SMS (Text Message) to a smart device including a user id for tracking purposes. -
SubmitDIDRequest
Submit a DID request (RESTRICTED ACCESS) -
SubmitOrder
Submit an order for services (RESTRICTED ACCESS) -
TrackShortLink
Gets tracking information about a short link. Pass in the ShortLink name or the ShortLinkID. ShortLinkID must be 0 or greater. ID overrides name. -
TrackShortLinkByCampaign
Gets tracking information short link Campaigns. Pass in the Campaign name. -
TrackShortLinkCampaigns
Gets tracking information about all Campaigns. -
UpdateAccountInfo
Update Account Info (RESTRICTED ACCESS) -
UpdateIVRSettings
Adds or updates IVR settings for an account. Account must exist. -
ValidImageTypes
Returns a list of valid image types for images uploaded with CreateShortLink, CreateShortLink2 and SendSMSAttachment.