Service Web Service

Service

Click here for a complete list of operations.

SendMessage

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
ewBusinessUser:
ewBusinessToken:
Message:
IndividualID:
AgentPhoneNumber:
FromPhoneNumber:
ToPhoneNumber:
FirstName:
LastName:
TagCode:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Service.asmx HTTP/1.1
Host: api.everyware.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://wsclientapi.everyware.com/SendMessage"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SendMessage xmlns="http://wsclientapi.everyware.com/">
      <ewBusinessUser>string</ewBusinessUser>
      <ewBusinessToken>string</ewBusinessToken>
      <Message>string</Message>
      <IndividualID>int</IndividualID>
      <AgentPhoneNumber>string</AgentPhoneNumber>
      <FromPhoneNumber>string</FromPhoneNumber>
      <ToPhoneNumber>string</ToPhoneNumber>
      <FirstName>string</FirstName>
      <LastName>string</LastName>
      <TagCode>string</TagCode>
    </SendMessage>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SendMessageResponse xmlns="http://wsclientapi.everyware.com/">
      <SendMessageResult>
        <ResponseMessageInput>
          <FromPhoneNumber>string</FromPhoneNumber>
          <Error>string</Error>
          <ErrorStack>string</ErrorStack>
          <Response>string</Response>
          <ResponseMessage>string</ResponseMessage>
          <IndividualID>string</IndividualID>
          <MessageID>string</MessageID>
          <LeadID>string</LeadID>
          <DispositionID>string</DispositionID>
        </ResponseMessageInput>
        <ResponseMessageInput>
          <FromPhoneNumber>string</FromPhoneNumber>
          <Error>string</Error>
          <ErrorStack>string</ErrorStack>
          <Response>string</Response>
          <ResponseMessage>string</ResponseMessage>
          <IndividualID>string</IndividualID>
          <MessageID>string</MessageID>
          <LeadID>string</LeadID>
          <DispositionID>string</DispositionID>
        </ResponseMessageInput>
      </SendMessageResult>
    </SendMessageResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Service.asmx HTTP/1.1
Host: api.everyware.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SendMessage xmlns="http://wsclientapi.everyware.com/">
      <ewBusinessUser>string</ewBusinessUser>
      <ewBusinessToken>string</ewBusinessToken>
      <Message>string</Message>
      <IndividualID>int</IndividualID>
      <AgentPhoneNumber>string</AgentPhoneNumber>
      <FromPhoneNumber>string</FromPhoneNumber>
      <ToPhoneNumber>string</ToPhoneNumber>
      <FirstName>string</FirstName>
      <LastName>string</LastName>
      <TagCode>string</TagCode>
    </SendMessage>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SendMessageResponse xmlns="http://wsclientapi.everyware.com/">
      <SendMessageResult>
        <ResponseMessageInput>
          <FromPhoneNumber>string</FromPhoneNumber>
          <Error>string</Error>
          <ErrorStack>string</ErrorStack>
          <Response>string</Response>
          <ResponseMessage>string</ResponseMessage>
          <IndividualID>string</IndividualID>
          <MessageID>string</MessageID>
          <LeadID>string</LeadID>
          <DispositionID>string</DispositionID>
        </ResponseMessageInput>
        <ResponseMessageInput>
          <FromPhoneNumber>string</FromPhoneNumber>
          <Error>string</Error>
          <ErrorStack>string</ErrorStack>
          <Response>string</Response>
          <ResponseMessage>string</ResponseMessage>
          <IndividualID>string</IndividualID>
          <MessageID>string</MessageID>
          <LeadID>string</LeadID>
          <DispositionID>string</DispositionID>
        </ResponseMessageInput>
      </SendMessageResult>
    </SendMessageResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /Service.asmx/SendMessage?ewBusinessUser=string&ewBusinessToken=string&Message=string&IndividualID=string&AgentPhoneNumber=string&FromPhoneNumber=string&ToPhoneNumber=string&FirstName=string&LastName=string&TagCode=string HTTP/1.1
Host: api.everyware.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfResponseMessageInput xmlns="http://wsclientapi.everyware.com/">
  <ResponseMessageInput>
    <FromPhoneNumber>string</FromPhoneNumber>
    <Error>string</Error>
    <ErrorStack>string</ErrorStack>
    <Response>string</Response>
    <ResponseMessage>string</ResponseMessage>
    <IndividualID>string</IndividualID>
    <MessageID>string</MessageID>
    <LeadID>string</LeadID>
    <DispositionID>string</DispositionID>
  </ResponseMessageInput>
  <ResponseMessageInput>
    <FromPhoneNumber>string</FromPhoneNumber>
    <Error>string</Error>
    <ErrorStack>string</ErrorStack>
    <Response>string</Response>
    <ResponseMessage>string</ResponseMessage>
    <IndividualID>string</IndividualID>
    <MessageID>string</MessageID>
    <LeadID>string</LeadID>
    <DispositionID>string</DispositionID>
  </ResponseMessageInput>
</ArrayOfResponseMessageInput>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /Service.asmx/SendMessage HTTP/1.1
Host: api.everyware.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ewBusinessUser=string&ewBusinessToken=string&Message=string&IndividualID=string&AgentPhoneNumber=string&FromPhoneNumber=string&ToPhoneNumber=string&FirstName=string&LastName=string&TagCode=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfResponseMessageInput xmlns="http://wsclientapi.everyware.com/">
  <ResponseMessageInput>
    <FromPhoneNumber>string</FromPhoneNumber>
    <Error>string</Error>
    <ErrorStack>string</ErrorStack>
    <Response>string</Response>
    <ResponseMessage>string</ResponseMessage>
    <IndividualID>string</IndividualID>
    <MessageID>string</MessageID>
    <LeadID>string</LeadID>
    <DispositionID>string</DispositionID>
  </ResponseMessageInput>
  <ResponseMessageInput>
    <FromPhoneNumber>string</FromPhoneNumber>
    <Error>string</Error>
    <ErrorStack>string</ErrorStack>
    <Response>string</Response>
    <ResponseMessage>string</ResponseMessage>
    <IndividualID>string</IndividualID>
    <MessageID>string</MessageID>
    <LeadID>string</LeadID>
    <DispositionID>string</DispositionID>
  </ResponseMessageInput>
</ArrayOfResponseMessageInput>