com.ringcentral.definitions.AggregateA2PSMSStatusesParameters Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ringcentral Show documentation

RingCentral Java SDK

There is a newer version: 3.2.1

package com.ringcentral.definitions;


/**
 * Query parameters for operation aggregateA2PSMSStatuses
 */
public class AggregateA2PSMSStatusesParameters {
    /**
     * Internal identifier of a message batch to filter the response
     * Example: 55577
     */
    public String batchId;
    /**
     * Direction of the SMS message
     * Example: Inbound
     * Enum: Inbound, Outbound
     */
    public String direction;
    /**
     * The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours
     * Format: date-time
     * Example: 2020-11-09T16:07:52.597Z
     */
    public String dateFrom;
    /**
     * The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time
     * Format: date-time
     * Example: 2020-11-25T16:07:52.597Z
     */
    public String dateTo;
    /**
     * List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15
     * Example: 15551234455,15551235577
     */
    public String[] phoneNumber;

    public AggregateA2PSMSStatusesParameters batchId(String batchId) {
        this.batchId = batchId;
        return this;
    }

    public AggregateA2PSMSStatusesParameters direction(String direction) {
        this.direction = direction;
        return this;
    }

    public AggregateA2PSMSStatusesParameters dateFrom(String dateFrom) {
        this.dateFrom = dateFrom;
        return this;
    }

    public AggregateA2PSMSStatusesParameters dateTo(String dateTo) {
        this.dateTo = dateTo;
        return this;
    }

    public AggregateA2PSMSStatusesParameters phoneNumber(String[] phoneNumber) {
        this.phoneNumber = phoneNumber;
        return this;
    }
}