POST api/communications

Creates a communication.

Request Information

URI Parameters

None.

Body Parameters

Information needed to create the communication.

Name	Description	Type	Additional information
NumPages	Number of pages.	integer	None.
Sender	Sender of a talk. Optional. If indicated, must be a user within the account. If missing, the sender will be the authenticated user.	string	None.
RecipientData	Information about the recipients, including name, email addresses, mobile phone numbers and language.	Collection of RecipientData	None.
SenderData	Information about the sender.	SenderData	None.
Subject	Subject of the talk.	string	None.
Body	Text of the talk.	string	None.
TalkModel	Talk model of the talk.	TalkModels	None.
Attachments	List of attachments of the talk.	Collection of Attachment	None.
Hostname	Machine name of the user.	string	None.
IP	IP address of the user.	string	None.
BatchId	Identifier of the upload.	string	None.
UserReferenceId	User reference.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Sender": "sample string 1",
  "Recipients": [
    "sample string 1",
    "sample string 2"
  ],
  "RecipientData": [
    {
      "$id": "2",
      "RecipientName": "sample string 1",
      "RecipientEmail": "sample string 2",
      "RecipientPhoneNumber": "sample string 3",
      "RecipientTypeId": "To",
      "RecipientLanguage": "sample string 4",
      "RecipientSignatureLocation": {
        "$id": "3",
        "Page": 1,
        "Left": 2.1,
        "Top": 3.1,
        "Right": 4.1,
        "Bottom": 5.1
      },
      "RecipientPostalAddress": "sample string 5",
      "RecipientPostalCode": "sample string 6",
      "RecipientCity": "sample string 7",
      "RecipientProvince": "sample string 8",
      "RecipientCountryId": "sample string 9",
      "RecipientIdentityNumber": "sample string 10",
      "RecipientObservations": "sample string 11",
      "RecipientOthers": "sample string 12",
      "RecipientContentCertificate": true
    },
    {
      "$ref": "2"
    }
  ],
  "SenderData": {
    "$id": "4",
    "FullName": "sample string 1",
    "PostalAddress": "sample string 2",
    "PostalCode": "sample string 3",
    "City": "sample string 4",
    "Province": "sample string 5",
    "CountryId": "sample string 6",
    "PhoneNumber": "sample string 7"
  },
  "Cc": [
    "sample string 1",
    "sample string 2"
  ],
  "Bcc": [
    "sample string 1",
    "sample string 2"
  ],
  "Subject": "sample string 2",
  "Body": "sample string 3",
  "TalkModel": "None",
  "Attachments": [
    {
      "$id": "5",
      "FileId": 1,
      "FileName": "sample string 1",
      "FileSize": 2,
      "Hash": "sample string 3",
      "MetaData": {
        "$id": "6",
        "Title": "sample string 1",
        "Author": "sample string 2",
        "Subject": "sample string 3",
        "Keywords": "sample string 4",
        "Creator": "sample string 5",
        "Producer": "sample string 6",
        "CreationDate": "2024-12-03T02:03:19.9801636+01:00",
        "ModifiedDate": "2024-12-03T02:03:19.9801636+01:00",
        "PageCount": 1,
        "Screenshot": "QEA=",
        "Width": "sample string 7",
        "Height": "sample string 8",
        "Depth": "sample string 9",
        "Description": "sample string 10",
        "GPSLatitude": "sample string 11",
        "GPSLatitudeRef": "sample string 12",
        "GPSLongitude": "sample string 13",
        "GPSLongitudeRef": "sample string 14",
        "FNumber": "sample string 15",
        "ExposureTime": "sample string 16",
        "ISOSpeed": "sample string 17",
        "Make": "sample string 18",
        "Model": "sample string 19",
        "DateTimeDigitized": "2024-12-03T02:03:19.9801636+01:00"
      }
    },
    {
      "$ref": "5"
    }
  ],
  "Hostname": "sample string 4",
  "IP": "sample string 5",
  "BatchId": "sample string 6",
  "UserReferenceId": "sample string 7",
  "NumPages": 1
}

application/xml, text/xml

Sample:

<Conversation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" xmlns="http://schemas.datacontract.org/2004/07/PuntoNeutro.Core.Talks">
  <Attachments>
    <Attachment z:Id="i2">
      <FileId>1</FileId>
      <FileName>sample string 1</FileName>
      <FileSize>2</FileSize>
      <Hash>sample string 3</Hash>
      <MetaData z:Id="i3">
        <Author>sample string 2</Author>
        <CreationDate>2024-12-03T02:03:19.9801636+01:00</CreationDate>
        <Creator>sample string 5</Creator>
        <DateTimeDigitized>2024-12-03T02:03:19.9801636+01:00</DateTimeDigitized>
        <Depth>sample string 9</Depth>
        <Description>sample string 10</Description>
        <ExposureTime>sample string 16</ExposureTime>
        <FNumber>sample string 15</FNumber>
        <GPSLatitude>sample string 11</GPSLatitude>
        <GPSLatitudeRef>sample string 12</GPSLatitudeRef>
        <GPSLongitude>sample string 13</GPSLongitude>
        <GPSLongitudeRef>sample string 14</GPSLongitudeRef>
        <Height>sample string 8</Height>
        <ISOSpeed>sample string 17</ISOSpeed>
        <Keywords>sample string 4</Keywords>
        <Make>sample string 18</Make>
        <Model>sample string 19</Model>
        <ModifiedDate>2024-12-03T02:03:19.9801636+01:00</ModifiedDate>
        <PageCount>1</PageCount>
        <Producer>sample string 6</Producer>
        <Screenshot>QEA=</Screenshot>
        <Subject>sample string 3</Subject>
        <Title>sample string 1</Title>
        <Width>sample string 7</Width>
      </MetaData>
    </Attachment>
    <Attachment z:Ref="i2" />
  </Attachments>
  <BatchId>sample string 6</BatchId>
  <Bcc xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Bcc>
  <Body>sample string 3</Body>
  <Cc xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Cc>
  <Hostname>sample string 4</Hostname>
  <IP>sample string 5</IP>
  <NumPages>1</NumPages>
  <RecipientData>
    <RecipientData>
      <RecipientCity>sample string 7</RecipientCity>
      <RecipientContentCertificate>true</RecipientContentCertificate>
      <RecipientCountryId>sample string 9</RecipientCountryId>
      <RecipientEmail>sample string 2</RecipientEmail>
      <RecipientIdentityNumber>sample string 10</RecipientIdentityNumber>
      <RecipientLanguage>sample string 4</RecipientLanguage>
      <RecipientName>sample string 1</RecipientName>
      <RecipientObservations>sample string 11</RecipientObservations>
      <RecipientOthers>sample string 12</RecipientOthers>
      <RecipientPhoneNumber>sample string 3</RecipientPhoneNumber>
      <RecipientPostalAddress>sample string 5</RecipientPostalAddress>
      <RecipientPostalCode>sample string 6</RecipientPostalCode>
      <RecipientProvince>sample string 8</RecipientProvince>
      <RecipientSignatureLocation>
        <Bottom>5.1</Bottom>
        <Left>2.1</Left>
        <Page>1</Page>
        <Right>4.1</Right>
        <Top>3.1</Top>
      </RecipientSignatureLocation>
      <RecipientTypeId>To</RecipientTypeId>
    </RecipientData>
    <RecipientData>
      <RecipientCity>sample string 7</RecipientCity>
      <RecipientContentCertificate>true</RecipientContentCertificate>
      <RecipientCountryId>sample string 9</RecipientCountryId>
      <RecipientEmail>sample string 2</RecipientEmail>
      <RecipientIdentityNumber>sample string 10</RecipientIdentityNumber>
      <RecipientLanguage>sample string 4</RecipientLanguage>
      <RecipientName>sample string 1</RecipientName>
      <RecipientObservations>sample string 11</RecipientObservations>
      <RecipientOthers>sample string 12</RecipientOthers>
      <RecipientPhoneNumber>sample string 3</RecipientPhoneNumber>
      <RecipientPostalAddress>sample string 5</RecipientPostalAddress>
      <RecipientPostalCode>sample string 6</RecipientPostalCode>
      <RecipientProvince>sample string 8</RecipientProvince>
      <RecipientSignatureLocation>
        <Bottom>5.1</Bottom>
        <Left>2.1</Left>
        <Page>1</Page>
        <Right>4.1</Right>
        <Top>3.1</Top>
      </RecipientSignatureLocation>
      <RecipientTypeId>To</RecipientTypeId>
    </RecipientData>
  </RecipientData>
  <Recipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Recipients>
  <Sender>sample string 1</Sender>
  <SenderData>
    <City>sample string 4</City>
    <CountryId>sample string 6</CountryId>
    <FullName>sample string 1</FullName>
    <PhoneNumber>sample string 7</PhoneNumber>
    <PostalAddress>sample string 2</PostalAddress>
    <PostalCode>sample string 3</PostalCode>
    <Province>sample string 5</Province>
  </SenderData>
  <Subject>sample string 2</Subject>
  <TalkModel>None</TalkModel>
  <UserReferenceId>sample string 7</UserReferenceId>
</Conversation>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Parent communication identifier.

integer

Response Formats

application/json, text/json

Sample:

application/xml, text/xml

Sample:

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>