pathParams = [ 'authId' => $authId ]; $this->uri = "Account/".$authId."/Application/"; } /** * Create a new application * * @param string $appName The name of your application * @param array $optionalArgs * + Valid arguments with their types * + string answer_url - The URL that will be notified by Plivo when the call is answered. * + string answer_method - The method used to call the answer_url. Defaults to POST. * + string hangup_url - The URL that will be notified by Plivo when the call hangs up. Defaults to answer_url. * + string hangup_method - The method used to call the hangup_url. Defaults to POST. * + string fallback_answer_url - Invoked by Plivo only if answer_url is unavailable or the XML response is invalid. Should contain a XML response. * + string fallback_method - The method used to call the fallback_answer_url. Defaults to POST. * + string message_url - The URL that will be notified by Plivo when an inbound message is received. Defaults not set. * + string message_method - The method used to call the message_url. Defaults to POST. * + boolean default_number_app - If set to true, this parameter ensures that newly created numbers, which don't have an app_id, point to this application. * + boolean default_endpoint_app - If set to true, this parameter ensures that newly created endpoints, which don't have an app_id, point to this application. * + string subaccount - Id of the subaccount, in case only subaccount applications are needed. * + boolean log_incoming_messages - controls the incoming message logs. * * @return ApplicationCreateResponse output */ public function create( $appName, array $optionalArgs = []) { $mandaoryArgs = [ 'app_name' => $appName ]; $optionalArgs['isVoiceRequest'] = true; $response = $this->client->update( $this->uri, array_merge($mandaoryArgs, $optionalArgs) ); $responseContents = $response->getContent(); if(!array_key_exists("error",$responseContents)){ return new ApplicationCreateResponse( $responseContents['api_id'], $responseContents['app_id'], $responseContents['message'], $response->getStatusCode() ); } else { throw new PlivoResponseException( $responseContents['error'], 0, null, $response->getContent(), $response->getStatusCode() ); } } /** * Modify an application * * @param string $appId * * @param array $optionalArgs * + Valid arguments with their types * + string answer_url - The URL invoked by Plivo when a call executes this application. * + string answer_method - The method used to call the answer_url. Defaults to POST. * + string hangup_url - The URL that will be notified by Plivo when the call hangs up. Defaults to answer_url. * + string hangup_method - The method used to call the hangup_url. Defaults to POST. * + string fallback_answer_url - Invoked by Plivo only if answer_url is unavailable or the XML response is invalid. Should contain a XML response. * + string fallback_method - The method used to call the fallback_answer_url. Defaults to POST. * + string message_url - The URL that will be notified by Plivo when an inbound message is received. Defaults not set. * + string message_method - The method used to call the message_url. Defaults to POST. * + boolean default_number_app - If set to true, this parameter ensures that newly created numbers, which don't have an app_id, point to this application. * + boolean default_endpoint_app - If set to true, this parameter ensures that newly created endpoints, which don't have an app_id, point to this application. * + string subaccount - Id of the subaccount, in case only subaccount applications are needed. * + boolean log_incoming_messages - controls the incoming message logs. * * @return ResponseUpdate */ public function update($appId, array $optionalArgs = []) { $optionalArgs['isVoiceRequest'] = true; $response = $this->client->update( $this->uri . $appId . '/', $optionalArgs ); $responseContents = $response->getContent(); if(!array_key_exists("error",$responseContents)){ return new ResponseUpdate( $responseContents['api_id'], $responseContents['message'], $response->getStatusCode() ); } else { throw new PlivoResponseException( $responseContents['error'], 0, null, $response->getContent(), $response->getStatusCode() ); } } /** * Delete an application * @param string $appId * @param array $optionalArgs * + boolean cascade - Delete associated endpoints * + string new_endpoint_application - Link associated endpoints with new application * * @return ResponseDelete */ public function delete($appId, array $optionalArgs = []) { $optionalArgs['isVoiceRequest'] = true; $response = $this->client->delete( $this->uri . $appId . '/', $optionalArgs ); return new ResponseDelete($response->getStatusCode()); } /** * Retrive an application * @param string $appId * @return Application * @throws PlivoValidationException */ public function get($appId) { if (ArrayOperations::checkNull([$appId])) { throw new PlivoValidationException( 'app id is mandatory'); } $optionalArgs['isVoiceRequest'] = true; $response = $this->client->fetch( $this->uri . $appId . '/', $optionalArgs ); return new Application( $this->client, $response->getContent(), $this->pathParams['authId']); } /** * Retrieve a list of applications * * @param array $optionalArgs * + Valid arguments * + string subaccount - Id of the subaccount, in case only subaccount applications are needed. * + integer limit - Used to display the number of results per page. The maximum number of results that can be fetched is 20. * + integer offset - Denotes the number of value items by which the results should be offset. Eg:- If the result contains a 1000 values and limit is set to 10 and offset is set to 705, then values 706 through 715 are displayed in the results. This parameter is also used for pagination of the results. * * @return ApplicationList */ public function getList(array $optionalArgs = []) { $optionalArgs['isVoiceRequest'] = true; $response = $this->client->fetch( $this->uri, $optionalArgs ); $applications = []; foreach ($response->getContent()['objects'] as $application) { $newApplication = new Application( $this->client, $application, $this->pathParams['authId']); array_push($applications, $newApplication); } return new ApplicationList( $this->client, $response->getContent()['meta'], $applications); } }