Phonenumber Storage

POST - Add New Number

POST https://{API URL}/api/PhoneNumberStorageItem

Request

{
    "storageID":"{storageID}",
    "number":"{number}",
    // parameter 1 - 9 are not required and can be left out if not needed, 
    // additionally you can just keep the ones that you want to use if needed
    "parameter1":"{string}",
    "parameter2":"{string}",
    "parameter3":"{string}",
    "parameter4":"{string}",
    "parameter5":"{string}",
    "parameter6":"{string}",
    "parameter7":"{string}",
    "parameter8":"{string}",
    "parameter9":"{string}"
}

Response

201 Created

PUT - Update Stored Number

POST https://{API URL}/api/PhoneNumberStorageItem

Request

{
    "storageID":"{storageID}",
    "number":"{number}",
    "parameter1":"{string}",
    "parameter2":"{string}",
    "parameter3":"{string}",
    "parameter4":"{string}",
    "parameter5":"{string}",
    "parameter6":"{string}",
    "parameter7":"{string}",
    "parameter8":"{string}",
    "parameter9":"{string}"
}

Response

204 No Content

GET - Retrieve Single Stored Number

GET https://{API URL}//api/PhoneNumberStorageItem/:storageId

Request

Parameter	Type	Description
:storageId	string	ID of the stored item

Response

200 OK

{
    "storageID":"{storageID}",
    "number":"{number}",
    "parameter1":"{string}",
    "parameter2":"{string}",
    "parameter3":"{string}",
    "parameter4":"{string}",
    "parameter5":"{string}",
    "parameter6":"{string}",
    "parameter7":"{string}",
    "parameter8":"{string}",
    "parameter9":"{string}"
}

GET - Retrieves A Pagintated List of Stored Numbers

GET https://{API URL}//api/PhoneNumberStorageItem/:pageSize/:pageIndex

Request

Parameter	Type	Description
:pageSize	int	Number of records to return on each page
:pageIndex	int	The page index

Response

200 OK

{
    "pageIndex": 1,
    "totalPages": 20,
    "totalRecords": 200000,
    "items": [
        {
            "storageID":"{storageID}",
            "number":"{number}",
            "parameter1":"{string}",
            "parameter2":"{string}",
            "parameter3":"{string}",
            "parameter4":"{string}",
            "parameter5":"{string}",
            "parameter6":"{string}",
            "parameter7":"{string}",
            "parameter8":"{string}",
            "parameter9":"{string}"
        },
        {
            ....
        }
    ]
}

400 Bad Request

{
    "pageSize": [
        "can not exceed 10000 records"
    ]
}

DELETE - Deletes Stored Number

POST https://{API URL}/api/PhoneNumberStorageItem/:storageId

Request

Parameter	Type	Description
:storageId	string	ID of the stored item