PV API Service

<back to all web services

SendMessageRequest

Send Message from a Direct Message Service

The following routes are available for this service:
POST, OPTIONS/DirectMessaging/SendMessage

To override the Content-type in your clients HTTP Accept Header, append ?format=xml

HTTP + XML

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

POST /xml/reply/SendMessageRequest HTTP/1.1 
Host: api.practicevelocity.com 
Content-Type: application/xml
Content-Length: length

<SendMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.DirectMessaging.DataModel.Messages">
  <Email xmlns:d2p1="http://schemas.datacontract.org/2004/07/PV.Data.DirectMessaging.Ccd.Dtos">
    <d2p1:Attachments>
      <d2p1:Attachment>
        <d2p1:Base64>String</d2p1:Base64>
        <d2p1:ContentType>String</d2p1:ContentType>
        <d2p1:FileName>String</d2p1:FileName>
      </d2p1:Attachment>
    </d2p1:Attachments>
    <d2p1:Bcc xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Bcc>
    <d2p1:Cc xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Cc>
    <d2p1:CreatedTime>0001-01-01T00:00:00</d2p1:CreatedTime>
    <d2p1:From>String</d2p1:From>
    <d2p1:HtmlBody>String</d2p1:HtmlBody>
    <d2p1:Subject>String</d2p1:Subject>
    <d2p1:TextBody>String</d2p1:TextBody>
    <d2p1:To xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:To>
  </Email>
  <EmailServiceType>DirectMessage</EmailServiceType>
  <LoggedInUser>String</LoggedInUser>
  <SessionKey>String</SessionKey>
</SendMessageRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SendMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.DirectMessaging.DataModel.Messages">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/PV.DirectMessaging.DataModel.Common">String</ErrorMessage>
  <MessageId>0</MessageId>
</SendMessageResponse>