Contact
Click here for a complete list of operations.
AddContact
Adds a new contact to an address book.
Parameter | Notes |
Username: | |
Password: | |
FirstName: | Provide a first name for you new contact. |
LastName: | Provide a second name for you new contact. |
MobilePhone: | Provide a mobile device number for you new contact. |
EmailAddress: | Provide an email address for you new contact. |
GroupName: | Provide a group name from your address book to put your new contact in. If you do not want to put the contact in a group set this parameter to null. |
Duplicate: | Determines if a contact can be added if their is already one present. |
ViewDetailResult: | Determines if the person number is returned to the user |
ContactIDArray: | Provide a string jagged array (e.g. string[][]) output parameter. This will be populated with elements containing information about an account's contacts that have been added to the address book. |
ResultText: | E.g. 3 entries added to address book for your.address@your.company. 3 entries added to group MyExistingGroup. |
Code: |
Test
The test form is only available for methods with primitive types as parameters.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 /WebServices/2.2/Complex/AddressBook/Contact.asmx HTTP/1.1 Host: www.2sms.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://www.2sms.com/WebServices/2.2/Complex/AddressBook/AddContact" <?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> <AddContact xmlns="http://www.2sms.com/WebServices/2.2/Complex/AddressBook/"> <Username>string</Username> <Password>string</Password> <FirstName>string</FirstName> <LastName>string</LastName> <MobilePhone>string</MobilePhone> <EmailAddress>string</EmailAddress> <GroupName>string</GroupName> <Duplicate>boolean</Duplicate> <ViewDetailResult>boolean</ViewDetailResult> <ContactIDArray> <ArrayOfString> <string>string</string> <string>string</string> </ArrayOfString> <ArrayOfString> <string>string</string> <string>string</string> </ArrayOfString> </ContactIDArray> <ResultText>string</ResultText> <Code>string</Code> </AddContact> </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> <AddContactResponse xmlns="http://www.2sms.com/WebServices/2.2/Complex/AddressBook/"> <AddContactResult>string</AddContactResult> <ContactIDArray> <ArrayOfString> <string>string</string> <string>string</string> </ArrayOfString> <ArrayOfString> <string>string</string> <string>string</string> </ArrayOfString> </ContactIDArray> <ResultText>string</ResultText> <Code>string</Code> </AddContactResponse> </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 /WebServices/2.2/Complex/AddressBook/Contact.asmx HTTP/1.1 Host: www.2sms.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> <AddContact xmlns="http://www.2sms.com/WebServices/2.2/Complex/AddressBook/"> <Username>string</Username> <Password>string</Password> <FirstName>string</FirstName> <LastName>string</LastName> <MobilePhone>string</MobilePhone> <EmailAddress>string</EmailAddress> <GroupName>string</GroupName> <Duplicate>boolean</Duplicate> <ViewDetailResult>boolean</ViewDetailResult> <ContactIDArray> <ArrayOfString> <string>string</string> <string>string</string> </ArrayOfString> <ArrayOfString> <string>string</string> <string>string</string> </ArrayOfString> </ContactIDArray> <ResultText>string</ResultText> <Code>string</Code> </AddContact> </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> <AddContactResponse xmlns="http://www.2sms.com/WebServices/2.2/Complex/AddressBook/"> <AddContactResult>string</AddContactResult> <ContactIDArray> <ArrayOfString> <string>string</string> <string>string</string> </ArrayOfString> <ArrayOfString> <string>string</string> <string>string</string> </ArrayOfString> </ContactIDArray> <ResultText>string</ResultText> <Code>string</Code> </AddContactResponse> </soap12:Body> </soap12:Envelope>