RT*M
In our bilingual documentation you will find out all the info you need for the development using our APIs: from detailed descriptions of all APIs and SDKs to examples of codes.

Developer Garden User Documentation

Version 3.2.2


Table of Contents

1. Introduction
1.1. About this documentation
1.2. Change history
1.3. Feedback
1.4. Copyright
2. Comprehensive information
2.1. Service usage options
2.2. Registration
2.3. Support
2.3.1. Community support
2.3.2. Direct support
2.4. Environments
2.5. Billing
2.6. Account-based service use
2.7. Quota mechanism
2.8. Authentication
2.8.1. Use of the provided SDKs
2.8.2. Use of the SOAP or REST interfaces
3. SDKs
3.1. General information
3.2. Java SDK
3.2.1. Requirements
3.2.2. Directory structure
3.2.3. Package structure
3.2.4. Invocation of a Telekom API method
3.2.5. Retrieving status code descriptions
3.2.6. Handling errors and exceptions
3.2.7. Specifying proxy settings
3.2.8. JUnit software tests
3.2.9. Source code documentation
3.2.10. Examples
3.3. .NET SDK
3.3.1. System requirements
3.3.2. Directory structure
3.3.3. Namespace structure
3.3.4. Invocation of a Telekom API method
3.3.5. Retrieving status code descriptions
3.3.6. Handling errors and exceptions
3.3.7. Specifying proxy settings
3.3.8. Using the .NET SDKs in a hosted IIS WCF WebService
3.3.9. Software tests
3.3.10. Source code documentation
3.3.11. Example projects
3.4. PHP SDK
3.4.1. System requirements
3.4.2. Directory structure
3.4.3. Namespace structure
3.4.4. Invocation of a Telekom API method
3.4.5. Retrieving status code descriptions
3.4.6. Handling errors and exceptions
3.4.7. Specifying proxy settings
3.4.8. Software tests
3.4.9. Source code documentation
3.4.10. Code examples
3.5. Objective-C SDK
3.5.1. System requirements
3.5.2. Directory structure
3.5.3. Structure
3.5.4. Invocation of a Telekom API method
3.5.5. Retrieving status code descriptions
3.5.6. Fehler- Ausnahmebehandlung
3.5.7. Source-Code Dokumentation
3.5.8. JSON Handling
3.5.9. HTTP Request Handling
3.5.10. Example Apps
4. Services
4.1. Comprehensive information
4.1.1. Supported phone number formats
4.2. Voice Call
4.2.1. Overview
4.2.2. Restrictions
4.2.3. Special features in the mock environment
4.2.4. SOAP method: newCall - create a voice connection
4.2.5. SOAP method: newCallSequenced - create a sequential voice connection
4.2.6. SOAP method: callStatus - request the status of a call/extend a call
4.2.7. SOAP method: teardownCall - end a call
4.2.8. REST method: create a voice connection / create a sequential voice connection
4.2.9. REST method: request the status of a call/extend a call
4.2.10. REST method: end a call
4.2.11. Voice Call error codes.
4.3. Conference Call
4.3.1. Overview
4.3.2. Setting up a phone conference
4.3.3. Restrictions
4.3.4. Special features in the mock environment
4.3.5. SOAP method: commitConference - save created conference in the Conference Call Server
4.3.6. SOAP method: createConference - create new conference
4.3.7. SOAP method: getConferenceList - display list of conferences
4.3.8. SOAP method: getConferenceStatus - display information about a conference
4.3.9. SOAP method: getParticipantStatus - displays status information about a conference participant
4.3.10. SOAP method: newParticipant - Add participant to conference
4.3.11. SOAP method: removeConference - remove conference
4.3.12. SOAP method: removeParticipant - remove participant from conference
4.3.13. SOAP method: updateConference - update conference
4.3.14. SOAP method: updateParticipant - update participant details, mute, redial
4.3.15. SOAP method: getRunningConference - request the running instance of a planned conference
4.3.16. SOAP method: createConferenceTemplate - creates a new conference template
4.3.17. SOAP method: getConferenceTemplate - request a conference template
4.3.18. SOAP method: updateConferenceTemplate - update conference template details
4.3.19. SOAP method: removeConferenceTemplate - remove conference template
4.3.20. SOAP method: getConferenceTemplateList - request all conference templates of an owner
4.3.21. SOAP method: getConferenceTemplateParticipant - display details of a participant of a conference template
4.3.22. SOAP method: updateConferenceTemplateParticipant - update participant details of a conference template
4.3.23. SOAP method: removeConferenceTemplateParticipant - remove participant of a conference template
4.3.24. SOAP method: addConferenceTemplateParticipant - add conference participant to conference template
4.3.25. SOAP method: uploadAnnouncement - Allows uploading a new announcement
4.3.26. SOAP method: editAnnouncement - Allows changing a specific announcement
4.3.27. SOAP method: deleteAnnouncementSet - Deletes a group of announcements
4.3.28. SOAP method: getAnnouncementSets - Provides a list of all announcement sets
4.3.29. SOAP type ConferenceDetails - Detailed information about the conference
4.3.30. SOAP type ConferenceSchedule - With a planned conference, this field contains the planning information
4.3.31. SOAP type ParticipantStatus - Status of the conference participant
4.3.32. SOAP type ParticipantDetail - Participants of the conference template
4.3.33. REST method: save created conference in the Conference Call Server
4.3.34. REST method: create new conference
4.3.35. REST method: display list of conferences
4.3.36. REST method: display information about a conference
4.3.37. REST method: displays status information about a conference participant
4.3.38. REST method: Add participant to conference
4.3.39. REST method: remove conference
4.3.40. REST method: remove participant from conference
4.3.41. REST method: update conference
4.3.42. REST method: update participant details, mute, redial
4.3.43. REST method: request the running instance of a planned conference
4.3.44. REST method: creates a new conference template
4.3.45. REST method: request a conference template
4.3.46. REST method: update conference template details
4.3.47. REST method: remove conference template
4.3.48. REST method: request all conference templates of an owner
4.3.49. REST method: display details of a participant of a conference template
4.3.50. REST method: update participant details of a conference template
4.3.51. REST method: remove participant of a conference template
4.3.52. REST method: add conference participant to conference template
4.3.53. REST method: Allows changing a specific announcement
4.3.54. REST method: Allows uploading a new announcement
4.3.55. REST method: Deletes a group of announcements
4.3.56. REST method: Provides a list of all announcement sets
4.3.57. Conference Call error codes.
4.4. Send SMS
4.4.1. Overview
4.4.2. Restrictions
4.4.3. Special features in the mock environment
4.4.4. SOAP method: sendSMS - send an SMS
4.4.5. SOAP method: sendFlashSMS - send a Flash SMS
4.4.6. REST method: send an SMS / send a Flash SMS
4.4.7. Send SMS error codes.
4.5. Send MMS
4.5.1. Overview
4.5.2. Restrictions
4.5.3. Special features in the mock environment
4.5.4. SOAP method: sendMMS - send an MMS
4.5.5. SOAP type Attachment - null
4.5.6. REST method: send an MMS
4.5.7. Send MMS error codes.
4.6. Send SMS - Phone number validation
4.6.1. Overview
4.6.2. Functionality
4.6.3. Restrictions
4.6.4. Special features in the mock environment
4.6.5. SOAP method: sendValidationKeyword - Send a validation SMS
4.6.6. SOAP method: validate - validation of a phone number
4.6.7. SOAP method: invalidate - withdrawal of a validation, termination of a validation process
4.6.8. SOAP method: getValidatedNumbers - query list of validated numbers
4.6.9. REST method: Send a validation SMS
4.6.10. REST method: validation of a phone number
4.6.11. REST method: withdrawal of a validation, termination of a validation process
4.6.12. REST method: query list of validated numbers
4.6.13. Send SMS - Phone number validation error codes.
4.7. Auto Scout 24
4.7.1. Overview
4.7.2. SOAP method: findArticles - Query the article database
4.7.3. SOAP method: getLookupData - List all enumeration values
4.7.4. SOAP method: getMakeModelTree - Retrieve the model tree structure
4.7.5. SOAP type equipments - List of vehicle equipments
4.7.6. SOAP type root_paths - Container for as24urlroot and images
4.7.7. SOAP type seals - List of seals
4.7.8. SOAP type XCode - Additional information
4.7.9. SOAP type price - Price range
4.7.10. SOAP type ArrayOfprice - List of prices
4.7.11. SOAP type MediaOfImageMediaXCodeAmSZe6zN - image media xcode
4.7.12. SOAP type MediaXCode - XCode
4.7.13. SOAP type ImageListOfImage19jCfK4b - List of images
4.7.14. SOAP type Image - The image of an article
4.7.15. SOAP type ConsumptionOfConsumptionData19jCfK4b - list of consumption data
4.7.16. SOAP type ConsumptionData - Vehicle consumption data
4.7.17. SOAP type property - property
4.7.18. SOAP type ArrayOfproperty - array of property
4.7.19. SOAP type Availability - vehicle avability
4.7.20. SOAP type Emission - emission
4.7.21. SOAP type OwnerXCode - List of additional owner information
4.7.22. SOAP type OwnerList - List of vehicle owners
4.7.23. SOAP type OwnersOfOwnerList19jCfK4b - List of vehicle owners
4.7.24. SOAP type PreviousOwnerOfOwnerList19jCfK4b - list of previous owner
4.7.25. SOAP type error - An error
4.7.26. SOAP type ArrayOferror - Array of errors
4.7.27. SOAP type Build - Build information
4.7.28. SOAP type TimeStamp - Timestamp, ISO Format
4.7.29. SOAP type element - An element
4.7.30. SOAP type vehicle - vehicle container
4.7.31. SOAP type GetLookupDataContainer - The container for a look up data request
4.7.32. SOAP type GetLookupDataRequest - Request for look up data
4.7.33. SOAP type GetLookupDataResponseContainer - The Container for GetlookUpData response.
4.7.34. SOAP type GetLookupDataResponse - The look up data
4.7.35. SOAP type stx3_idpool - A pool of IDs
4.7.36. SOAP type ArrayOfelement - Array of elements
4.7.37. SOAP type node - A Node
4.7.38. SOAP type ArrayOfnode - Array of nodes
4.7.39. SOAP type GetMakeModelTreeContainer - The container for GetMakeModelTree request.
4.7.40. SOAP type GetMakeModelTreeRequest - Request for the tree structure of makes and models
4.7.41. SOAP type GetMakeModelTreeResponseContainer - Container for getMakeModelTree response
4.7.42. SOAP type GetMakeModelTreeResponse - Tree structure of makes and models
4.7.43. SOAP type FindArticlesContainer - The container for the vehicle search parameters
4.7.44. SOAP type FindArticlesRequest - The vehicle search parameters
4.7.45. SOAP type SearchParameters - Search parameters
4.7.46. SOAP type ZipSearch - Zip search parameters
4.7.47. SOAP type Countries - Get or set countries
4.7.48. SOAP type AvailabilitySearch - Avability search parameters
4.7.49. SOAP type FromValueOfNullableOfdateTime5F2dSckg - Get or set datetime
4.7.50. SOAP type FromToOfNullableOfdateTime5F2dSckg - A time range
4.7.51. SOAP type BodyTypes - Vehicle body type
4.7.52. SOAP type BodyColours - Vehicle body color
4.7.53. SOAP type PaintingTypes - A list of paint types
4.7.54. SOAP type Makes - A list of car makes
4.7.55. SOAP type ArticleCategories - Article categories
4.7.56. SOAP type FromToOfNullableOfint5F2dSckg - An integer range
4.7.57. SOAP type EmissionSearch - Emmission search parameters
4.7.58. SOAP type FromValueOfNullableOfint5F2dSckg - integer
4.7.59. SOAP type FuelTypes - The vehicle fuel type
4.7.60. SOAP type GearingTypes - The vehicle gearing type
4.7.61. SOAP type FromToOfNullableOfdecimal5F2dSckg - A decimal range
4.7.62. SOAP type ModelLines - A list of model lines
4.7.63. SOAP type Models - A list of car models
4.7.64. SOAP type Paging - Paging information
4.7.65. SOAP type PriceFromTo - Price range
4.7.66. SOAP type Sorting - Sorting information (key, descending, ...)
4.7.67. SOAP type FindArticlesResponseContainer - The Container for FindArticle response.
4.7.68. SOAP type FindArticlesResponse - The article search results
4.7.69. SOAP type ArrayOfvehicle - Array of vehicles
4.7.70. REST method: Query the article database
4.7.71. REST method: List all enumeration values
4.7.72. REST method: Retrieve the model tree structure
4.7.73. REST type VehicleSearchParameters (The vehicle search parameters)
4.7.74. REST type LookUpData (The resulting look up data)
4.7.75. REST type STX3IDPool (Array of elements: elements and nodes)
4.7.76. REST type Element (An element)
4.7.77. REST type ArrayOfNodes (An array of nodes)
4.7.78. REST type Node (A Node)
4.7.79. REST type MakeModelTree (The container for GetMakeModelTree response.)
4.7.80. Auto Scout 24 error codes.
4.8. IP Location
4.8.1. Overview
4.8.2. Restrictions
4.8.3. Special features of the environments
4.8.4. List of the IP location regions
4.8.5. SOAP method: locateIP - determine local information of an IP address
4.8.6. SOAP type IPAdress - Local information for one or more IP addresses
4.8.7. REST method: determine local information of an IP address
4.8.8. IP Location error codes.
4.9. Administration service (Quota and Accounts)
4.9.1. Overview
4.9.2. SOAP method: getQuotaInformation - request quota
4.9.3. SOAP method: changeQuotaPool - set quota
4.9.4. SOAP method: getAccountBalance - query account balance
4.9.5. SOAP method: getChargedAmount - request connection costs
4.9.6. REST method: request quota
4.9.7. REST method: set quota
4.9.8. REST method: query account balance
4.9.9. REST method: request connection costs
4.9.10. Administration service (Quota and Accounts) error codes.
5. Samples
5.1. Voice Call
5.1.1. Connecting two phones
5.1.1.1. Java
5.1.1.2. .NET
5.1.1.3. PHP
5.2. Conference Call
5.2.1. Initiating a conference with three participants
5.2.1.1. Java
5.2.1.2. .NET
5.2.1.3. PHP
5.3. Send SMS
5.3.1. Sending an SMS
5.3.1.1. Java
5.3.1.2. .NET
5.3.1.3. PHP
5.4. Send MMS
5.4.1. Sending an MMS with an attached image
5.4.1.1. Java
5.4.1.2. .NET
5.4.1.3. PHP
5.5. Send SMS - Phone number validation
5.5.1. Sending a validation keyword
5.5.1.1. Java
5.5.1.2. .NET
5.5.1.3. PHP
5.5.2. Validating a number using the validation message
5.5.2.1. Java
5.5.2.2. .NET
5.5.2.3. PHP
5.6. Auto Scout 24
5.6.1. Finds AutoScout24 articles
5.6.1.1. Java
5.6.1.2. PHP
5.6.1.3. Dotnet
5.6.2. Get look up data
5.6.2.1. Java
5.6.2.2. PHP
5.6.2.3. Dotnet
5.6.3. Get make model tree
5.6.3.1. Java
5.6.3.2. PHP
5.6.3.3. Dotnet
5.7. IP Location
5.7.1. Locating an IP address
5.7.1.1. Java
5.7.1.2. .NET
5.7.1.3. PHP
A. Service address using the SOAP or REST interface
A.1. Introduction
A.2. Service address using the SOAP interface
A.2.1. Notes
A.2.2. Communication process
A.2.2.1. Step 1: Obtain an authentication token from the Security Token Server (STS)
A.2.2.2. Step 2: Use of an opened service while specifying the authentication token
A.2.3. SOAP end points
A.2.4. SOAP WSDL files
A.3. Service address using the REST interface
A.3.1. Communication process
A.3.1.1. Step 1: Obtain an authentication token from the Security Token Server (STS)
A.3.1.1.1. Response of the Security Token Server
A.3.1.1.2. Security Token Server error handling
A.3.1.2. Step 2: Use of an opened service while specifying the authentication token
A.4. Environment constants

List of Tables

1.1. Change history of the Open Development user documentation
2.1. Overview of the two usage options for the services
2.2. Overview of the environments
4.1. Phone numbers in the mock environment
4.2. Parameters of SOAP method: newCall - create a voice connection
4.3. Return values of SOAP method: newCall - create a voice connection
4.4. Parameters of SOAP method: newCallSequenced - create a sequential voice connection
4.5. Return values of SOAP method: newCallSequenced - create a sequential voice connection
4.6. Parameters of SOAP method: callStatus - request the status of a call/extend a call
4.7. Return values of SOAP method: callStatus - request the status of a call/extend a call
4.8. Parameters of SOAP method: teardownCall - end a call
4.9. Return values of SOAP method: teardownCall - end a call
4.10. REST resource information:
4.11. REST resource path
4.12. Parameters of REST method: create a voice connection / create a sequential voice connection
4.13. Return values of REST method: create a voice connection / create a sequential voice connection
4.14. REST resource information:
4.15. REST resource path
4.16. Parameters of REST method: request the status of a call/extend a call
4.17. Return values of REST method: request the status of a call/extend a call
4.18. REST resource information:
4.19. REST resource path
4.20. Return values of REST method: end a call
4.21. Voice Call error codes.
4.22. Controlling a conference with DTMF tones
4.23. Conference Call - production environment
4.24. Phone numbers in the mock environment
4.25. Parameters of SOAP method: commitConference - save created conference in the Conference Call Server
4.26. Return values of SOAP method: commitConference - save created conference in the Conference Call Server
4.27. Parameters of SOAP method: createConference - create new conference
4.28. Return values of SOAP method: createConference - create new conference
4.29. Parameters of SOAP method: getConferenceList - display list of conferences
4.30. Return values of SOAP method: getConferenceList - display list of conferences
4.31. Parameters of SOAP method: getConferenceStatus - display information about a conference
4.32. Return values of SOAP method: getConferenceStatus - display information about a conference
4.33. Parameters of SOAP method: getParticipantStatus - displays status information about a conference participant
4.34. Return values of SOAP method: getParticipantStatus - displays status information about a conference participant
4.35. Parameters of SOAP method: newParticipant - Add participant to conference
4.36. Return values of SOAP method: newParticipant - Add participant to conference
4.37. Parameters of SOAP method: removeConference - remove conference
4.38. Return values of SOAP method: removeConference - remove conference
4.39. Parameters of SOAP method: removeParticipant - remove participant from conference
4.40. Return values of SOAP method: removeParticipant - remove participant from conference
4.41. Parameters of SOAP method: updateConference - update conference
4.42. Return values of SOAP method: updateConference - update conference
4.43. Parameters of SOAP method: updateParticipant - update participant details, mute, redial
4.44. Return values of SOAP method: updateParticipant - update participant details, mute, redial
4.45. Parameters of SOAP method: getRunningConference - request the running instance of a planned conference
4.46. Return values of SOAP method: getRunningConference - request the running instance of a planned conference
4.47. Parameters of SOAP method: createConferenceTemplate - creates a new conference template
4.48. Return values of SOAP method: createConferenceTemplate - creates a new conference template
4.49. Parameters of SOAP method: getConferenceTemplate - request a conference template
4.50. Return values of SOAP method: getConferenceTemplate - request a conference template
4.51. Parameters of SOAP method: updateConferenceTemplate - update conference template details
4.52. Return values of SOAP method: updateConferenceTemplate - update conference template details
4.53. Parameters of SOAP method: removeConferenceTemplate - remove conference template
4.54. Return values of SOAP method: removeConferenceTemplate - remove conference template
4.55. Parameters of SOAP method: getConferenceTemplateList - request all conference templates of an owner
4.56. Return values of SOAP method: getConferenceTemplateList - request all conference templates of an owner
4.57. Parameters of SOAP method: getConferenceTemplateParticipant - display details of a participant of a conference template
4.58. Return values of SOAP method: getConferenceTemplateParticipant - display details of a participant of a conference template
4.59. Parameters of SOAP method: updateConferenceTemplateParticipant - update participant details of a conference template
4.60. Return values of SOAP method: updateConferenceTemplateParticipant - update participant details of a conference template
4.61. Parameters of SOAP method: removeConferenceTemplateParticipant - remove participant of a conference template
4.62. Return values of SOAP method: removeConferenceTemplateParticipant - remove participant of a conference template
4.63. Parameters of SOAP method: addConferenceTemplateParticipant - add conference participant to conference template
4.64. Return values of SOAP method: addConferenceTemplateParticipant - add conference participant to conference template
4.65. Parameters of SOAP method: uploadAnnouncement - Allows uploading a new announcement
4.66. Return values of SOAP method: uploadAnnouncement - Allows uploading a new announcement
4.67. Parameters of SOAP method: editAnnouncement - Allows changing a specific announcement
4.68. Return values of SOAP method: editAnnouncement - Allows changing a specific announcement
4.69. Parameters of SOAP method: deleteAnnouncementSet - Deletes a group of announcements
4.70. Return values of SOAP method: deleteAnnouncementSet - Deletes a group of announcements
4.71. Parameters of SOAP method: getAnnouncementSets - Provides a list of all announcement sets
4.72. Return values of SOAP method: getAnnouncementSets - Provides a list of all announcement sets
4.73. SOAP type ConferenceDetails - Detailed information about the conference
4.74. SOAP type ConferenceSchedule - With a planned conference, this field contains the planning information
4.75. SOAP type ParticipantStatus - Status of the conference participant
4.76. SOAP type ParticipantDetail - Participants of the conference template
4.77. REST resource information:
4.78. REST resource path
4.79. Return values of REST method: save created conference in the Conference Call Server
4.80. REST resource information:
4.81. REST resource path
4.82. Parameters of REST method: create new conference
4.83. Return values of REST method: create new conference
4.84. REST resource information:
4.85. REST resource path
4.86. Parameters of REST method: display list of conferences
4.87. Return values of REST method: display list of conferences
4.88. REST resource information:
4.89. REST resource path
4.90. Parameters of REST method: display information about a conference
4.91. Return values of REST method: display information about a conference
4.92. REST resource information:
4.93. REST resource path
4.94. Return values of REST method: displays status information about a conference participant
4.95. REST resource information:
4.96. REST resource path
4.97. Parameters of REST method: Add participant to conference
4.98. Return values of REST method: Add participant to conference
4.99. REST resource information:
4.100. REST resource path
4.101. Return values of REST method: remove conference
4.102. REST resource information:
4.103. REST resource path
4.104. Return values of REST method: remove participant from conference
4.105. REST resource information:
4.106. REST resource path
4.107. Parameters of REST method: update conference
4.108. Return values of REST method: update conference
4.109. REST resource information:
4.110. REST resource path
4.111. Parameters of REST method: update participant details, mute, redial
4.112. Return values of REST method: update participant details, mute, redial
4.113. REST resource information:
4.114. REST resource path
4.115. Return values of REST method: request the running instance of a planned conference
4.116. REST resource information:
4.117. REST resource path
4.118. Parameters of REST method: creates a new conference template
4.119. Return values of REST method: creates a new conference template
4.120. REST resource information:
4.121. REST resource path
4.122. Return values of REST method: request a conference template
4.123. REST resource information:
4.124. REST resource path
4.125. Parameters of REST method: update conference template details
4.126. Return values of REST method: update conference template details
4.127. REST resource information:
4.128. REST resource path
4.129. Return values of REST method: remove conference template
4.130. REST resource information:
4.131. REST resource path
4.132. Return values of REST method: request all conference templates of an owner
4.133. REST resource information:
4.134. REST resource path
4.135. Return values of REST method: display details of a participant of a conference template
4.136. REST resource information:
4.137. REST resource path
4.138. Parameters of REST method: update participant details of a conference template
4.139. Return values of REST method: update participant details of a conference template
4.140. REST resource information:
4.141. REST resource path
4.142. Return values of REST method: remove participant of a conference template
4.143. REST resource information:
4.144. REST resource path
4.145. Parameters of REST method: add conference participant to conference template
4.146. Return values of REST method: add conference participant to conference template
4.147. REST resource information:
4.148. REST resource path
4.149. Parameters of REST method: Allows changing a specific announcement
4.150. Return values of REST method: Allows changing a specific announcement
4.151. REST resource information:
4.152. REST resource path
4.153. Parameters of REST method: Allows uploading a new announcement
4.154. Return values of REST method: Allows uploading a new announcement
4.155. REST resource information:
4.156. REST resource path
4.157. Return values of REST method: Deletes a group of announcements
4.158. REST resource information:
4.159. REST resource path
4.160. Return values of REST method: Provides a list of all announcement sets
4.161. Conference Call error codes.
4.162. Parameters of SOAP method: sendSMS - send an SMS
4.163. Return values of SOAP method: sendSMS - send an SMS
4.164. Parameters of SOAP method: sendFlashSMS - send a Flash SMS
4.165. Return values of SOAP method: sendFlashSMS - send a Flash SMS
4.166. REST resource information:
4.167. REST resource path
4.168. Parameters of REST method: send an SMS / send a Flash SMS
4.169. Return values of REST method: send an SMS / send a Flash SMS
4.170. Send SMS error codes.
4.171. Parameters of SOAP method: sendMMS - send an MMS
4.172. Return values of SOAP method: sendMMS - send an MMS
4.173. SOAP type Attachment - null
4.174. REST resource information:
4.175. REST resource path
4.176. Parameters of REST method: send an MMS
4.177. Return values of REST method: send an MMS
4.178. Send MMS error codes.
4.179. Parameters of SOAP method: sendValidationKeyword - Send a validation SMS
4.180. Return values of SOAP method: sendValidationKeyword - Send a validation SMS
4.181. Parameters of SOAP method: validate - validation of a phone number
4.182. Return values of SOAP method: validate - validation of a phone number
4.183. Parameters of SOAP method: invalidate - withdrawal of a validation, termination of a validation process
4.184. Return values of SOAP method: invalidate - withdrawal of a validation, termination of a validation process
4.185. Return values of SOAP method: getValidatedNumbers - query list of validated numbers
4.186. REST resource information:
4.187. REST resource path
4.188. Parameters of REST method: Send a validation SMS
4.189. Return values of REST method: Send a validation SMS
4.190. REST resource information:
4.191. REST resource path
4.192. Parameters of REST method: validation of a phone number
4.193. Return values of REST method: validation of a phone number
4.194. REST resource information:
4.195. REST resource path
4.196. Return values of REST method: withdrawal of a validation, termination of a validation process
4.197. REST resource information:
4.198. REST resource path
4.199. Return values of REST method: query list of validated numbers
4.200. Send SMS - Phone number validation error codes.
4.201. Parameters of SOAP method: findArticles - Query the article database
4.202. Return values of SOAP method: findArticles - Query the article database
4.203. Parameters of SOAP method: getLookupData - List all enumeration values
4.204. Return values of SOAP method: getLookupData - List all enumeration values
4.205. Parameters of SOAP method: getMakeModelTree - Retrieve the model tree structure
4.206. Return values of SOAP method: getMakeModelTree - Retrieve the model tree structure
4.207. SOAP type equipments - List of vehicle equipments
4.208. SOAP type root_paths - Container for as24urlroot and images
4.209. SOAP type seals - List of seals
4.210. SOAP type XCode - Additional information
4.211. SOAP type price - Price range
4.212. SOAP type ArrayOfprice - List of prices
4.213. SOAP type MediaOfImageMediaXCodeAmSZe6zN - image media xcode
4.214. SOAP type MediaXCode - XCode
4.215. SOAP type ImageListOfImage19jCfK4b - List of images
4.216. SOAP type Image - The image of an article
4.217. SOAP type ConsumptionOfConsumptionData19jCfK4b - list of consumption data
4.218. SOAP type ConsumptionData - Vehicle consumption data
4.219. SOAP type property - property
4.220. SOAP type ArrayOfproperty - array of property
4.221. SOAP type Availability - vehicle avability
4.222. SOAP type Emission - emission
4.223. SOAP type OwnerXCode - List of additional owner information
4.224. SOAP type OwnerList - List of vehicle owners
4.225. SOAP type OwnersOfOwnerList19jCfK4b - List of vehicle owners
4.226. SOAP type PreviousOwnerOfOwnerList19jCfK4b - list of previous owner
4.227. SOAP type error - An error
4.228. SOAP type ArrayOferror - Array of errors
4.229. SOAP type Build - Build information
4.230. SOAP type TimeStamp - Timestamp, ISO Format
4.231. SOAP type element - An element
4.232. SOAP type vehicle - vehicle container
4.233. SOAP type GetLookupDataContainer - The container for a look up data request
4.234. SOAP type GetLookupDataRequest - Request for look up data
4.235. SOAP type GetLookupDataResponseContainer - The Container for GetlookUpData response.
4.236. SOAP type GetLookupDataResponse - The look up data
4.237. SOAP type stx3_idpool - A pool of IDs
4.238. SOAP type ArrayOfelement - Array of elements
4.239. SOAP type node - A Node
4.240. SOAP type ArrayOfnode - Array of nodes
4.241. SOAP type GetMakeModelTreeContainer - The container for GetMakeModelTree request.
4.242. SOAP type GetMakeModelTreeRequest - Request for the tree structure of makes and models
4.243. SOAP type GetMakeModelTreeResponseContainer - Container for getMakeModelTree response
4.244. SOAP type GetMakeModelTreeResponse - Tree structure of makes and models
4.245. SOAP type FindArticlesContainer - The container for the vehicle search parameters
4.246. SOAP type FindArticlesRequest - The vehicle search parameters
4.247. SOAP type SearchParameters - Search parameters
4.248. SOAP type ZipSearch - Zip search parameters
4.249. SOAP type Countries - Get or set countries
4.250. SOAP type AvailabilitySearch - Avability search parameters
4.251. SOAP type FromValueOfNullableOfdateTime5F2dSckg - Get or set datetime
4.252. SOAP type FromToOfNullableOfdateTime5F2dSckg - A time range
4.253. SOAP type BodyTypes - Vehicle body type
4.254. SOAP type BodyColours - Vehicle body color
4.255. SOAP type PaintingTypes - A list of paint types
4.256. SOAP type Makes - A list of car makes
4.257. SOAP type ArticleCategories - Article categories
4.258. SOAP type FromToOfNullableOfint5F2dSckg - An integer range
4.259. SOAP type EmissionSearch - Emmission search parameters
4.260. SOAP type FromValueOfNullableOfint5F2dSckg - integer
4.261. SOAP type FuelTypes - The vehicle fuel type
4.262. SOAP type GearingTypes - The vehicle gearing type
4.263. SOAP type FromToOfNullableOfdecimal5F2dSckg - A decimal range
4.264. SOAP type ModelLines - A list of model lines
4.265. SOAP type Models - A list of car models
4.266. SOAP type Paging - Paging information
4.267. SOAP type PriceFromTo - Price range
4.268. SOAP type Sorting - Sorting information (key, descending, ...)
4.269. SOAP type FindArticlesResponseContainer - The Container for FindArticle response.
4.270. SOAP type FindArticlesResponse - The article search results
4.271. SOAP type ArrayOfvehicle - Array of vehicles
4.272. REST resource information:
4.273. REST resource path
4.274. Parameters of REST method: Query the article database
4.275. Return values of REST method: Query the article database
4.276. REST resource information:
4.277. REST resource path
4.278. Parameters of REST method: List all enumeration values
4.279. Return values of REST method: List all enumeration values
4.280. REST resource information:
4.281. REST resource path
4.282. Parameters of REST method: Retrieve the model tree structure
4.283. Return values of REST method: Retrieve the model tree structure
4.284. REST type VehicleSearchParameters (The vehicle search parameters)
4.285. REST type LookUpData (The resulting look up data)
4.286. REST type STX3IDPool (Array of elements: elements and nodes)
4.287. REST type Element (An element)
4.288. REST type ArrayOfNodes (An array of nodes)
4.289. REST type Node (A Node)
4.290. REST type MakeModelTree (The container for GetMakeModelTree response.)
4.291. Auto Scout 24 error codes.
4.292. Special features of the environments
4.293. List of regions
4.294. Parameters of SOAP method: locateIP - determine local information of an IP address
4.295. Return values of SOAP method: locateIP - determine local information of an IP address
4.296. SOAP type IPAdress - Local information for one or more IP addresses
4.297. REST resource information:
4.298. REST resource path
4.299. Parameters of REST method: determine local information of an IP address
4.300. Return values of REST method: determine local information of an IP address
4.301. IP Location error codes.
4.302. Parameters of SOAP method: getQuotaInformation - request quota
4.303. Return values of SOAP method: getQuotaInformation - request quota
4.304. Parameters of SOAP method: changeQuotaPool - set quota
4.305. Return values of SOAP method: changeQuotaPool - set quota
4.306. Parameters of SOAP method: getAccountBalance - query account balance
4.307. Return values of SOAP method: getAccountBalance - query account balance
4.308. Parameters of SOAP method: getChargedAmount - request connection costs
4.309. Return values of SOAP method: getChargedAmount - request connection costs
4.310. REST resource information:
4.311. REST resource path
4.312. Return values of REST method: request quota
4.313. REST resource information:
4.314. REST resource path
4.315. Parameters of REST method: set quota
4.316. Return values of REST method: set quota
4.317. REST resource information:
4.318. REST resource path
4.319. Parameters of REST method: query account balance
4.320. Return values of REST method: query account balance
4.321. REST resource information:
4.322. REST resource path
4.323. Parameters of REST method: request connection costs
4.324. Return values of REST method: request connection costs
4.325. Administration service (Quota and Accounts) error codes.
A.1. SOAP end points of the Open Development services
A.2. SOAP WSDL files of the Open Development services
A.3. Possible STS errors
A.4. Environment constants

List of Examples

3.1. Instantiation of the voice call client class
3.2. Invocating the newCall() method of the client
3.3. Retrieving a status code description using the Java SDK
3.4. Handling VoiceCall errors
3.5. Specifying proxy settings using Java system properties
3.6. Specifying proxy settings using Java runtime settings
3.7. Instantiation of the voice call client class
3.8. Invocating the NewCall() method of the client
3.9. Retrieving a status code description using the .NET SDK
3.10. Handling VoiceCall errors
3.11. Configuration of proxy settings through the WebHttpBinding object
3.12. Instantiation of the voice call client class
3.13. Invocating the NewCall() method of the client
3.14. Retrieving a status code description using the .NET SDK
3.15. Handling VoiceCall errors
3.16. Configuration of proxy settings through additional cURL options
3.17. Instantiation of the voice call client class
3.18. Invocating the newCall() method of the client
3.19. Retrieving a status code description using the Java SDK
3.20. Handling VoiceCall errors
3.21. Handling JSON server responses
3.22. Create JSON strings
3.23. Set up a TkomHttpRequest
5.1. Connecting two phones (Java)
5.2. Connecting two phones (.NET)
5.3. Connecting two phones (PHP)
5.4. Initiating a conference with three participants (Java)
5.5. Initiating a conference with three participants (.NET)
5.6. Initiating a conference with three participants (PHP)
5.7. Sending an SMS (Java)
5.8. Sending an SMS (.NET)
5.9. Sending an SMS (PHP)
5.10. Sending an MMS with an attached image (Java)
5.11. Sending an MMS with an attached image (.NET)
5.12. Sending an MMS with an attached image (PHP)
5.13. Sending a validation keyword (Java)
5.14. Sending a validation keyword (.NET)
5.15. Sending a validation keyword (PHP)
5.16. Validating a number using the validation message (Java)
5.17. Validating a number using the validation message (.NET)
5.18. Validating a number using the validation message (PHP)
5.19. Finds AutoScout24 articles (Java)
5.20. Finds AutoScout24 articles (PHP)
5.21. Finds AutoScout24 articles (Dotnet)
5.22. Get look up data (Java)
5.23. Get look up data (PHP)
5.24. Get look up data (Dotnet)
5.25. Get make model tree (Java)
5.26. Get make model tree (PHP)
5.27. Get make model tree (Dotnet)
5.28. Locating an IP address (Java)
5.29. Locating an IP address (.NET)
5.30. Locating an IP address (PHP)
A.1. Login message
A.2. Login response message including intermediary token
A.3. Request of the security token while specifying the intermediary token
A.4. Response message with authentication token
A.5. Call of the quota administration service with an associated authentication token
A.6. Response message: getQuotaInformationResponse
A.7. Requesting a Security Token
A.8. Response in application/json format
A.9. Response in text/plain format
A.10. Response in text/xml format
A.11. Error information in application/json format
A.12. Error information in text/plain format
A.13. Error information in text/xml format
A.14. Example request (Voice Call)
A.15. Example response
A.16. Example response (Formatted as application/json)
A.17. Example response (Formatted as text/xml)
A.18. Example response (Formatted as text/plain)

DOWNLOAD DOCUMENTATION

DOWNLOAD ENGLISH VERSION OF THE DOCUMENTATION V3.2.2


Documentation Version 3.1 
Documentation Version 2.7 R1

SUPPORT VOICE RECORD LAB API

DOWNLOAD JAVA SDK

DOWNLOAD THE VOICE RECORD LAB JAVA SDK & THE ENGLISH API DOCU V1.0