SMS Gateway API

<back to all web services

SMSSend

Saves the specified SMS and sends it for background processing

Requires Authentication
The following routes are available for this service:
POST/api/sendmessage
POST/api/sendmessage/immediate
POST/api/send
POST/api/sms/send
POST/api/send/immediate
POST/api/sms/send/immediate
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Dvaravartman.Common.Model.ServiceModel
Imports Eros.Subtle.Dvaravartman.Common.Model
Imports Eros.Saguna.Common.Library.ServiceModels

Namespace Global

    Namespace Eros.Saguna.Common.Library.ServiceModels

        Public Partial Class BaseLicenseeEnforcedServiceModel
            Public Overridable Property LicenseeId As Guid
        End Class
    End Namespace

    Namespace Eros.Subtle.Dvaravartman.Common.Model

        Public Partial Class CommResponse
            Public Overridable Property CommId As Guid
            Public Overridable Property Reference As String
            Public Overridable Property Status As Boolean
            Public Overridable Property Message As String
        End Class

        Public Partial Class SMSContact
            Public Overridable Property Name As String
            Public Overridable Property PhoneNumber As String
            Public Overridable Property ContactId As Guid
        End Class

        Public Partial Class SMSModel
            Inherits BaseLicenseeEnforcedServiceModel
            Public Overridable Property From As SMSContact
            Public Overridable Property [To] As List(Of SMSContact)
            Public Overridable Property MessageBody As String
            Public Overridable Property ReplyIsAllowed As Boolean
            Public Overridable Property ReplyIsRequired As Boolean
            Public Overridable Property Notes As String
            Public Overridable Property LinkedObjectId As Guid
            Public Overridable Property SuiteId As Guid
        End Class
    End Namespace

    Namespace Eros.Subtle.Dvaravartman.Common.Model.ServiceModel

        '''<Summary>
        '''Saves the specified SMS and sends it for background processing
        '''</Summary>
        <Api(Description:="Saves the specified SMS and sends it for background processing")>
        Public Partial Class SMSSend
            Public Overridable Property SMSModel As SMSModel
            Public Overridable Property CreateCommunicationReferencesImmediately As Boolean
        End Class
    End Namespace
End Namespace

VB.NET SMSSend DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/sendmessage HTTP/1.1 
Host: production-eros-gateway-api-sms-wa.azurewebsites.net 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"SMSModel":{"From":{"Name":"String","PhoneNumber":"String","ContactId":"00000000000000000000000000000000"},"To":[{"Name":"String","PhoneNumber":"String","ContactId":"00000000000000000000000000000000"}],"MessageBody":"String","ReplyIsAllowed":false,"ReplyIsRequired":false,"Notes":"String","LinkedObjectId":"00000000000000000000000000000000","SuiteId":"00000000000000000000000000000000","LicenseeId":"00000000000000000000000000000000"},"CreateCommunicationReferencesImmediately":false}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"CommId":"00000000000000000000000000000000","Reference":"String","Status":false,"Message":"String"}