POST api/TwoFactorAuth?intSMSReqId={intSMSReqId}&intCreatedBy={intCreatedBy}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| intSMSReqId | integer |
Required |
|
| intCreatedBy | integer |
Required |
Body Parameters
clsSMSResp| Name | Description | Type | Additional information |
|---|---|---|---|
| http_code | integer |
None. |
|
| response_code | string |
None. |
|
| response_msg | string |
None. |
|
| data | clsSMSRespData |
None. |
Request Formats
application/json, text/json
Sample:
{
"http_code": 1,
"response_code": "sample string 2",
"response_msg": "sample string 3",
"data": {
"total_price": 1.0,
"total_count": 2,
"queued_count": 3,
"messages": [
{
"direction": "sample string 1",
"date": 2,
"to": "sample string 3",
"body": "sample string 4",
"from": "sample string 5",
"schedule": 6,
"message_id": "sample string 7",
"message_parts": 8,
"message_price": "sample string 9",
"from_email": {},
"list_id": {},
"custom_string": "sample string 12",
"contact_id": {},
"user_id": 14,
"subaccount_id": 15,
"country": "sample string 16",
"carrier": "sample string 17",
"status": "sample string 18"
},
{
"direction": "sample string 1",
"date": 2,
"to": "sample string 3",
"body": "sample string 4",
"from": "sample string 5",
"schedule": 6,
"message_id": "sample string 7",
"message_parts": 8,
"message_price": "sample string 9",
"from_email": {},
"list_id": {},
"custom_string": "sample string 12",
"contact_id": {},
"user_id": 14,
"subaccount_id": 15,
"country": "sample string 16",
"carrier": "sample string 17",
"status": "sample string 18"
}
],
"_currency": {
"currency_name_short": "sample string 1",
"currency_prefix_d": "sample string 2",
"currency_prefix_c": "sample string 3",
"currency_name_long": "sample string 4"
}
}
}
application/xml, text/xml
Sample:
<clsSMSResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pozitive_Bank_API.fonts.Models">
<data>
<_currency>
<currency_name_long>sample string 4</currency_name_long>
<currency_name_short>sample string 1</currency_name_short>
<currency_prefix_c>sample string 3</currency_prefix_c>
<currency_prefix_d>sample string 2</currency_prefix_d>
</_currency>
<messages>
<clsSMSRespMessage>
<body>sample string 4</body>
<carrier>sample string 17</carrier>
<contact_id />
<country>sample string 16</country>
<custom_string>sample string 12</custom_string>
<date>2</date>
<direction>sample string 1</direction>
<from>sample string 5</from>
<from_email />
<list_id />
<message_id>sample string 7</message_id>
<message_parts>8</message_parts>
<message_price>sample string 9</message_price>
<schedule>6</schedule>
<status>sample string 18</status>
<subaccount_id>15</subaccount_id>
<to>sample string 3</to>
<user_id>14</user_id>
</clsSMSRespMessage>
<clsSMSRespMessage>
<body>sample string 4</body>
<carrier>sample string 17</carrier>
<contact_id />
<country>sample string 16</country>
<custom_string>sample string 12</custom_string>
<date>2</date>
<direction>sample string 1</direction>
<from>sample string 5</from>
<from_email />
<list_id />
<message_id>sample string 7</message_id>
<message_parts>8</message_parts>
<message_price>sample string 9</message_price>
<schedule>6</schedule>
<status>sample string 18</status>
<subaccount_id>15</subaccount_id>
<to>sample string 3</to>
<user_id>14</user_id>
</clsSMSRespMessage>
</messages>
<queued_count>3</queued_count>
<total_count>2</total_count>
<total_price>1</total_price>
</data>
<http_code>1</http_code>
<response_code>sample string 2</response_code>
<response_msg>sample string 3</response_msg>
</clsSMSResp>
application/x-www-form-urlencoded
Sample:
Sample not available.
application/bson
Sample:
Binary JSON content. See http://bsonspec.org for details.
Response Information
Resource Description
SMSResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| intSMSReqId | integer |
None. |
|
| strHttp_Code | string |
None. |
|
| strResponse_Code | string |
None. |
|
| strResponse_Msg | string |
None. |
|
| strDirection | string |
None. |
|
| strDate | string |
None. |
|
| strTo | string |
None. |
|
| strBody | string |
None. |
|
| strFrom | string |
None. |
|
| intSchedule | integer |
None. |
|
| strMessage_Id | string |
None. |
|
| intMessage_Parts | integer |
None. |
|
| decMessage_Price | decimal number |
None. |
|
| strFrom_Email | string |
None. |
|
| intList_Id | integer |
None. |
|
| strCustom_String | string |
None. |
|
| intContact_Id | integer |
None. |
|
| intUser_Id | integer |
None. |
|
| intSubaccount_Id | integer |
None. |
|
| strCountry | string |
None. |
|
| strCarrier | string |
None. |
|
| strStatus | string |
None. |
|
| strCurrency_Name_Short | string |
None. |
|
| strCurrency_Prefix_D | string |
None. |
|
| strCurrency_Prefix_C | string |
None. |
|
| strCurrency_Name_Long | string |
None. |
|
| intCreatedBy | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"intSMSReqId": 1,
"strHttp_Code": "sample string 2",
"strResponse_Code": "sample string 3",
"strResponse_Msg": "sample string 4",
"strDirection": "sample string 5",
"strDate": "sample string 6",
"strTo": "sample string 7",
"strBody": "sample string 8",
"strFrom": "sample string 9",
"intSchedule": 10,
"strMessage_Id": "sample string 11",
"intMessage_Parts": 12,
"decMessage_Price": 13.0,
"strFrom_Email": "sample string 14",
"intList_Id": 15,
"strCustom_String": "sample string 16",
"intContact_Id": 17,
"intUser_Id": 18,
"intSubaccount_Id": 19,
"strCountry": "sample string 20",
"strCarrier": "sample string 21",
"strStatus": "sample string 22",
"strCurrency_Name_Short": "sample string 23",
"strCurrency_Prefix_D": "sample string 24",
"strCurrency_Prefix_C": "sample string 25",
"strCurrency_Name_Long": "sample string 26",
"intCreatedBy": 27
}
application/xml, text/xml
Sample:
<SMSResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pozitive_Bank_Entities"> <decMessage_Price>13</decMessage_Price> <intContact_Id>17</intContact_Id> <intCreatedBy>27</intCreatedBy> <intList_Id>15</intList_Id> <intMessage_Parts>12</intMessage_Parts> <intSMSReqId>1</intSMSReqId> <intSchedule>10</intSchedule> <intSubaccount_Id>19</intSubaccount_Id> <intUser_Id>18</intUser_Id> <strBody>sample string 8</strBody> <strCarrier>sample string 21</strCarrier> <strCountry>sample string 20</strCountry> <strCurrency_Name_Long>sample string 26</strCurrency_Name_Long> <strCurrency_Name_Short>sample string 23</strCurrency_Name_Short> <strCurrency_Prefix_C>sample string 25</strCurrency_Prefix_C> <strCurrency_Prefix_D>sample string 24</strCurrency_Prefix_D> <strCustom_String>sample string 16</strCustom_String> <strDate>sample string 6</strDate> <strDirection>sample string 5</strDirection> <strFrom>sample string 9</strFrom> <strFrom_Email>sample string 14</strFrom_Email> <strHttp_Code>sample string 2</strHttp_Code> <strMessage_Id>sample string 11</strMessage_Id> <strResponse_Code>sample string 3</strResponse_Code> <strResponse_Msg>sample string 4</strResponse_Msg> <strStatus>sample string 22</strStatus> <strTo>sample string 7</strTo> </SMSResponse>
application/bson
Sample:
Binary JSON content. See http://bsonspec.org for details.