POST api/ZainSms?username={username}&password={password}

Request Information

URI Parameters

Name	Description	Type	Additional information
username		string	Required
password		string	Required

Body Parameters

SmsData

Name	Type	Additional information
service_type	string	None.
recipient_numbers_type	string	None.
phone_numbers	Collection of string	None.
content	string	None.
sender_id	string	None.

Request Formats

application/json, text/json

Sample:

{
  "service_type": "sample string 1",
  "recipient_numbers_type": "sample string 2",
  "phone_numbers": [
    "sample string 1",
    "sample string 2"
  ],
  "content": "sample string 3",
  "sender_id": "sample string 4"
}

text/html

Sample:

{"service_type":"sample string 1","recipient_numbers_type":"sample string 2","phone_numbers":["sample string 1","sample string 2"],"content":"sample string 3","sender_id":"sample string 4"}

application/xml, text/xml

Sample:

<SmsData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <service_type>sample string 1</service_type>
  <recipient_numbers_type>sample string 2</recipient_numbers_type>
  <phone_numbers>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </phone_numbers>
  <content>sample string 3</content>
  <sender_id>sample string 4</sender_id>
</SmsData>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="service_type"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="recipient_numbers_type"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="phone_numbers[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="phone_numbers[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="content"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="sender_id"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

SmsDataApiResponse

Name	Description	Type	Additional information
status		string	None.
result		SmsResult	None.

Response Formats

application/json, text/json

Sample:

{
  "status": "sample string 1",
  "result": {
    "valid_numbers_count": 1,
    "invalid_numbers": [
      {
        "message_Content": "sample string 1",
        "job_id": "sample string 2",
        "smsID": "sample string 3",
        "smscId": "sample string 4",
        "message_type": "sample string 5",
        "message_id": "sample string 6",
        "reciepint_number": "sample string 7",
        "delivery_status": "sample string 8",
        "sendTime": "sample string 9",
        "send_time": "sample string 10",
        "sender_id": "sample string 11",
        "extra": "sample string 12"
      },
      {
        "message_Content": "sample string 1",
        "job_id": "sample string 2",
        "smsID": "sample string 3",
        "smscId": "sample string 4",
        "message_type": "sample string 5",
        "message_id": "sample string 6",
        "reciepint_number": "sample string 7",
        "delivery_status": "sample string 8",
        "sendTime": "sample string 9",
        "send_time": "sample string 10",
        "sender_id": "sample string 11",
        "extra": "sample string 12"
      }
    ],
    "invalid_numbers_count": 2,
    "total_messages": 3
  }
}

text/html

Sample:

{"status":"sample string 1","result":{"valid_numbers_count":1,"invalid_numbers":[{"message_Content":"sample string 1","job_id":"sample string 2","smsID":"sample string 3","smscId":"sample string 4","message_type":"sample string 5","message_id":"sample string 6","reciepint_number":"sample string 7","delivery_status":"sample string 8","sendTime":"sample string 9","send_time":"sample string 10","sender_id":"sample string 11","extra":"sample string 12"},{"message_Content":"sample string 1","job_id":"sample string 2","smsID":"sample string 3","smscId":"sample string 4","message_type":"sample string 5","message_id":"sample string 6","reciepint_number":"sample string 7","delivery_status":"sample string 8","sendTime":"sample string 9","send_time":"sample string 10","sender_id":"sample string 11","extra":"sample string 12"}],"invalid_numbers_count":2,"total_messages":3}}

application/xml, text/xml

Sample:

<SmsDataApiResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <status>sample string 1</status>
  <result>
    <valid_numbers_count>1</valid_numbers_count>
    <invalid_numbers>
      <InvalidNumbers>
        <message_Content>sample string 1</message_Content>
        <job_id>sample string 2</job_id>
        <smsID>sample string 3</smsID>
        <smscId>sample string 4</smscId>
        <message_type>sample string 5</message_type>
        <message_id>sample string 6</message_id>
        <reciepint_number>sample string 7</reciepint_number>
        <delivery_status>sample string 8</delivery_status>
        <sendTime>sample string 9</sendTime>
        <send_time>sample string 10</send_time>
        <sender_id>sample string 11</sender_id>
        <extra>sample string 12</extra>
      </InvalidNumbers>
      <InvalidNumbers>
        <message_Content>sample string 1</message_Content>
        <job_id>sample string 2</job_id>
        <smsID>sample string 3</smsID>
        <smscId>sample string 4</smscId>
        <message_type>sample string 5</message_type>
        <message_id>sample string 6</message_id>
        <reciepint_number>sample string 7</reciepint_number>
        <delivery_status>sample string 8</delivery_status>
        <sendTime>sample string 9</sendTime>
        <send_time>sample string 10</send_time>
        <sender_id>sample string 11</sender_id>
        <extra>sample string 12</extra>
      </InvalidNumbers>
    </invalid_numbers>
    <invalid_numbers_count>2</invalid_numbers_count>
    <total_messages>3</total_messages>
  </result>
</SmsDataApiResponse>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="status"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.valid_numbers_count"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[0].message_Content"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[0].job_id"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[0].smsID"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[0].smscId"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[0].message_type"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[0].message_id"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[0].reciepint_number"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[0].delivery_status"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[0].sendTime"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[0].send_time"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[0].sender_id"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[0].extra"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[1].message_Content"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[1].job_id"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[1].smsID"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[1].smscId"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[1].message_type"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[1].message_id"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[1].reciepint_number"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[1].delivery_status"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[1].sendTime"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[1].send_time"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[1].sender_id"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers[1].extra"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.invalid_numbers_count"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="result.total_messages"

3
--MultipartDataMediaFormatterBoundary1q2w3e--